ansible.builtin.bigip_gtm_datacenter (v2.4.6.0-1) — module

Install Ansible via pip

Install with pip install ansible==2.4.6.0.post1

Description

Manage BIG-IP data center configuration. A data center defines the location where the physical network components reside, such as the server and link objects that share the same subnet on the network. This module is able to manipulate the data center definitions in a BIG-IP

Requirements

• f5-sdk

Usage examples

Scanned by Steampunk Spotter

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

- name: Create data center "New York"
  bigip_gtm_datacenter:
      server: "big-ip"
      name: "New York"
      location: "222 West 23rd"
  delegate_to: localhost

Inputs

    
name:
    description:
    - The name of the data center.
    required: true

state:
    choices:
    - present
    - absent
    description:
    - The state of the datacenter on the BIG-IP. When C(present), guarantees that the
      data center exists. When C(absent) removes the data center from the BIG-IP. C(enabled)
      will enable the data center and C(disabled) will ensure the data center is disabled.
      At least one of state and enabled are required.

contact:
    description:
    - The name of the contact for the data center.

enabled:
    choices:
    - true
    - false
    description:
    - Whether the data center should be enabled. At least one of C(state) and C(enabled)
      are required.

location:
    description:
    - The location of the data center.

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
      password:
        aliases:
        - pass
        - pwd
        description:
        - The password for the user account used to connect to the BIG-IP.
        - You may omit this option by setting the environment variable C(F5_PASSWORD).
        required: true
        type: str
      server:
        description:
        - The BIG-IP 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
      ssh_keyfile:
        description:
        - Specifies the SSH keyfile to use to authenticate the connection to the remote
          device.  This argument is only used for I(cli) transports.
        - You may omit this option by setting the environment variable C(ANSIBLE_NET_SSH_KEYFILE).
        type: path
      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:
        - cli
        - 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 with. 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: '2.5'
    version_added_collection: f5networks.f5_modules

description:
    description:
    - The description of the data center.

Outputs

contact:
  description: The contact that was set on the datacenter
  returned: changed
  sample: admin@root.local
  type: string
description:
  description: The description that was set for the datacenter
  returned: changed
  sample: Datacenter in NYC
  type: string
enabled:
  description: Whether the datacenter is enabled or not
  returned: changed
  sample: true
  type: bool
location:
  description: The location that is set for the datacenter
  returned: changed
  sample: 222 West 23rd
  type: string
name:
  description: Name of the datacenter being manipulated
  returned: changed
  sample: foo
  type: string