f5networks.f5_modules.bigip_partition – Manage BIG-IP partitions

Note

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

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

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

New in version 1.0.0: of f5networks.f5_modules

Synopsis

• Manage partitions on the BIG-IP.

Parameters

Parameter		Choices/Defaults	Comments
description string			The description to attach to the partition.
name string / required			Name of the partition.
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.
route_domain integer			The default Route Domain to assign to the partition. If no route domain is specified, the default route domain for the system (typically zero) will be used only when creating a new partition.
state string		Choices: present ← absent	Whether the partition should exist or not.

Notes

Note

• Requires BIG-IP software version >= 12

• 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 partition "foo" using the default route domain
  bigip_partition:
    name: foo
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Create partition "bar" using a custom route domain
  bigip_partition:
    name: bar
    route_domain: 3
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Change route domain of partition "foo"
  bigip_partition:
    name: foo
    route_domain: 8
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Set a description for partition "foo"
  bigip_partition:
    name: foo
    description: Tenant CompanyA
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Delete the "foo" partition
  bigip_partition:
    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
description string	changed and success	The description of the partition. Sample: Example partition
route_domain integer	changed and success	Name of the route domain associated with the partition.

Authors

• Tim Rupp (@caphrim007)

• Wojciech Wypior (@wojtek0806)