f5networks.f5_modules.bigip_remote_user (1.28.0) — module

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 the default settings for remote user accounts on a BIG-IP system.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Modify default partition and console access
  bigip_remote_user:
    default_partition: Common
    console_access: true
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Modify default role, partition and console access
  bigip_remote_user:
    default_partition: Common
    default_role: manager
    console_access: true
    description: "Changed new settings"
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Revert to default settings
  bigip_remote_user:
    default_partition: all
    default_role: "no-access"
    console_access: false
    description: ""
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

Inputs

    
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

description:
    description:
    - User-defined description.
    type: str

default_role:
    choices:
    - acceleration-policy-editor
    - admin
    - application-editor
    - auditor
    - certificate-manager
    - firewall-manager
    - fraud-protection-manager
    - guest
    - irule-manager
    - manager
    - no-access
    - operator
    - resource-admin
    - user-manager
    - web-application-security-administrator
    - web-application-security-editor
    description:
    - Specifies the default role for all remote user accounts.
    - The default system value is C(no-access).
    type: str

console_access:
    description:
    - Enables or disables the default console access for all remote user accounts.
    - The default system value is C(disabled).
    type: bool

default_partition:
    description:
    - Specifies the default partition for all remote user accounts.
    - The default system value is C(all) for all partitions.
    type: str

Outputs

console_access:
  description: The default console access for all remote user accounts.
  returned: changed
  sample: false
  type: bool
default_partition:
  description: The default partition for all remote user accounts.
  returned: changed
  sample: Common
  type: str
default_role:
  description: The default role for all remote user accounts.
  returned: changed
  sample: auditor
  type: str
description:
  description: The user-defined description.
  returned: changed
  sample: Foo is bar
  type: str