f5networks.f5_modules.bigip_profile_ftp – Manages FTP profiles

Note

This plugin is part of the f5networks.f5_modules collection (version 1.7.1).

To install it use: ansible-galaxy collection install f5networks.f5_modules.

To use it in a playbook, specify: f5networks.f5_modules.bigip_profile_ftp.

New in version 1.0.0: of f5networks.f5_modules

Synopsis

• Manages FTP profiles on the BIG-IP system.

Parameters

Parameter		Choices/Defaults	Comments
allow_ftps boolean		Choices: no yes	Allows explicit FTPS negotiation.
description string			Description of the profile.
inherit_parent_profile boolean		Choices: no yes	Enables the FTP data channel to inherit the TCP profile used by the control channel. When no, the data channel uses FastL4 (BigProto) only.
log_profile string			Configures the ALG log profile that controls logging.
log_publisher string			Configures the log publisher that handles events logging for this profile.
name string / required			Specifies the name of the profile.
parent string			Specifies the profile from which this profile inherits settings. When creating a new profile, if this parameter is not specified, the default is the system-supplied ftp profile.
partition string		Default: "Common"	Device partition to manage resources on.
port integer			Specifies a service for the data channel port used for this FTP profile. Valid range of values is between 0 and 65535 inclusive.
provider dictionary added in 1.0.0 of f5networks.f5_modules			A dict object containing connection details.
	auth_provider string		Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices.
	no_f5_teem boolean	Choices: no yes	If yes, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable F5_TEEM.
	password string / required		The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable F5_PASSWORD. aliases: pass, pwd
	server string / required		The BIG-IP host. You may omit this option by setting the environment variable F5_SERVER.
	server_port integer	Default: 443	The BIG-IP server port. You may omit this option by setting the environment variable F5_SERVER_PORT.
	timeout integer		Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error.
	transport string	Choices: rest ←	Configures the transport connection to use when connecting to the remote device.
	user string / required		The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable F5_USER.
	validate_certs boolean	Choices: no yes ←	If no, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable F5_VALIDATE_CERTS.
security boolean		Choices: no yes	Enables secure FTP traffic for the BIG-IP Application Security Manager. This option can only be used if the system is licensed for the BIG-IP ASM.
state string		Choices: present ← absent	When state is present, ensures the ftp profile exists. When state is absent, ensures the ftp profile is removed.
translate_extended boolean		Choices: no yes	Translates RFC 2428 extended requests EPSV and EPRT to PASV and PORT when communicating with IPv4 servers. This option can only be used if the system is licensed for the BIG-IP Application Security Manager (ASM).

Notes

Note

• For more information on using Ansible to manage F5 Networks devices see https://www.ansible.com/integrations/networks/f5.

• Requires BIG-IP software version >= 12.

• The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the f5networks.f5_modules.bigip_config module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration.

Examples

- name: Create an ftp profile
  bigip_profile_ftp:
    name: foo
    parent: /Common/barfoo
    port: 2221
    allow_ftps: yes
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Modify an ftp profile
  bigip_profile_ftp:
    name: foo
    log_profile: /Common/alg_log
    log_publisher: /Common/foo_publisher
    security: yes
    description: my description
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Remove an ftp profile
  bigip_profile_ftp:
    name: foo
    state: absent
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
allow_ftps boolean	changed	Allow explicit FTPS negotiation. Sample: True
description string	changed	Description of the profile. Sample: Foo is bar
inherit_parent_profile boolean	changed	Enables the FTP data channel to inherit the TCP profile used by the control channel.
log_profile string	changed	The ALG log profile that controls logging. Sample: /Common/foo_log_profile
log_publisher list / elements=string	changed	The name of the log publisher that handles events logging for this profile. Sample: /Common/publisher_1
parent string	changed	Specifies the profile from which this profile inherits settings. Sample: /Common/ftp
port integer	changed	Specifies a service for the data channel port used for this FTP profile. Sample: 20
security boolean	changed	Enables secure FTP traffic for the BIG-IP Application Security Manager.
translate_extended boolean	changed	Translates RFC 2428 extended requests when communicating with IPv4 servers. Sample: True

Authors

• Wojciech Wypior (@wojtek0806)