f5networks.f5_modules.bigip_profile_ftp (1.28.0) — module

Manages FTP profiles

| "added in version" 1.0.0 of f5networks.f5_modules"

Authors: Wojciech Wypior (@wojtek0806)

Install collection

Install with ansible-galaxy collection install f5networks.f5_modules:==1.28.0


Add to requirements.yml

  collections:
    - name: f5networks.f5_modules
      version: 1.28.0

Description

Manages FTP profiles on the BIG-IP system.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create an ftp profile
  bigip_profile_ftp:
    name: foo
    parent: /Common/barfoo
    port: 2221
    allow_ftps: true
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Modify an ftp profile
  bigip_profile_ftp:
    name: foo
    log_profile: /Common/alg_log
    log_publisher: /Common/foo_publisher
    security: true
    description: my description
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Remove an ftp profile
  bigip_profile_ftp:
    name: foo
    state: absent
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

Inputs

    
name:
    description:
    - Specifies the name of the profile.
    required: true
    type: str

port:
    description:
    - Specifies a service for the data channel port used for this FTP profile.
    - Valid range of values is between C(0) and C(65535) inclusive.
    type: int

state:
    choices:
    - present
    - absent
    default: present
    description:
    - When C(state) is C(present), ensures the ftp profile exists.
    - When C(state) is C(absent), ensures the ftp profile is removed.
    type: str

parent:
    description:
    - 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 C(ftp) profile.
    type: str

provider:
    description:
    - A dict object containing connection details.
    suboptions:
      auth_provider:
        description:
        - Configures the auth provider for to obtain authentication tokens from the remote
          device.
        - This option is really used when working with BIG-IQ devices.
        type: str
      no_f5_teem:
        default: false
        description:
        - If C(yes), TEEM telemetry data is not sent to F5.
        - You may omit this option by setting the environment variable C(F5_TELEMETRY_OFF).
        - Previously used variable C(F5_TEEM) is deprecated as its name was confusing.
        type: bool
      password:
        aliases:
        - pass
        - pwd
        description:
        - The password for the user account used to connect to the BIG-IP or the BIG-IQ.
        - You may omit this option by setting the environment variable C(F5_PASSWORD).
        required: true
        type: str
      server:
        description:
        - The BIG-IP host or the BIG-IQ host.
        - You may omit this option by setting the environment variable C(F5_SERVER).
        required: true
        type: str
      server_port:
        default: 443
        description:
        - The BIG-IP server port.
        - You may omit this option by setting the environment variable C(F5_SERVER_PORT).
        type: int
      timeout:
        description:
        - 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.
        type: int
      transport:
        choices:
        - rest
        default: rest
        description:
        - Configures the transport connection to use when connecting to the remote device.
        type: str
      user:
        description:
        - The username to connect to the BIG-IP or the BIG-IQ. This user must have administrative
          privileges on the device.
        - You may omit this option by setting the environment variable C(F5_USER).
        required: true
        type: str
      validate_certs:
        default: true
        description:
        - If C(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 C(F5_VALIDATE_CERTS).
        type: bool
    type: dict
    version_added: 1.0.0
    version_added_collection: f5networks.f5_modules

security:
    description:
    - 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.
    type: bool

partition:
    default: Common
    description:
    - Device partition to manage resources on.
    type: str

allow_ftps:
    description:
    - Allows explicit FTPS negotiation.
    type: bool

description:
    description:
    - Description of the profile.
    type: str

log_profile:
    description:
    - Configures the ALG log profile that controls logging.
    type: str

log_publisher:
    description:
    - Configures the log publisher that handles events logging for this profile.
    type: str

translate_extended:
    description:
    - Translates RFC 2428 extended requests C(EPSV) and C(EPRT) to C(PASV) and C(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).
    type: bool

inherit_parent_profile:
    description:
    - Enables the FTP data channel to inherit the TCP profile used by the control channel.
    - When C(false), the data channel uses FastL4 (BigProto) only.
    type: bool

Outputs

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