bigip_selfip – Manage Self-IPs on a BIG-IP system — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# bigip_selfip – Manage Self-IPs on a BIG-IP system

- Synopsis

- Parameters

- Notes

- Examples

- Return Values

- Status

## Synopsis

- Manage Self-IPs on a BIG-IP system.

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
address string |  | The IP addresses for the new self IP. This value is ignored upon update as addresses themselves cannot be changed after they are created. This value is required when creating new self IPs.
allow_service list |  | Configure port lockdown for the Self IP. By default, the Self IP has a "default deny" policy. This can be changed to allow TCP and UDP ports as well as specific protocols. This list should contain `protocol`:`port` values.
description string added in 2.8 |  | Description of the traffic selector.
name string / required |  | The self IP to create. If this parameter is not specified, then it will default to the value supplied in the `address` parameter.
netmask string |  | The netmask for the self IP. When creating a new Self IP, this value is required.
partition string added in 2.5 | Default: "Common" | Device partition to manage resources on. You can set different partitions for Self IPs, but the address used may not match any other address used by a Self IP. In that sense, Self IPs are not isolated by partitions as other resources on a BIG-IP are.
provider dictionary added in 2.5 |  | 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.
| 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`.
| ssh_keyfile path |  | Specifies the SSH keyfile to use to authenticate the connection to the remote device. This argument is only used for cli transports. You may omit this option by setting the environment variable `ANSIBLE_NET_SSH_KEYFILE`.
| 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: cli 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 route domain id of the system. When creating a new Self IP, if this value is not specified, a default value of `0` will be used. This value cannot be changed after it is set.
state string | Choices: absent present ← | When `present`, guarantees that the Self-IP exists with the provided attributes. When `absent`, removes the Self-IP from the system.
traffic_group string |  | The traffic group for the Self IP addresses in an active-active, redundant load balancer configuration. When creating a new Self IP, if this value is not specified, the default of `/Common/traffic-group-local-only` will be used.
vlan string |  | The VLAN that the new self IPs will be on. When creating a new Self IP, this value is required.

## 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 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 Self IP
      bigip_selfip:
        address: 10.10.10.10
        name: self1
        netmask: 255.255.255.0
        vlan: vlan1
        provider:
          password: secret
          server: lb.mydomain.com
          user: admin
      delegate_to: localhost

    - name: Create Self IP with a Route Domain
      bigip_selfip:
        name: self1
        address: 10.10.10.10
        netmask: 255.255.255.0
        vlan: vlan1
        route_domain: 10
        allow_service: default
        provider:
          server: lb.mydomain.com
          user: admin
          password: secret
      delegate_to: localhost

    - name: Delete Self IP
      bigip_selfip:
        name: self1
        state: absent
        provider:
          user: admin
          password: secret
          server: lb.mydomain.com
      delegate_to: localhost

    - name: Allow management web UI to be accessed on this Self IP
      bigip_selfip:
        name: self1
        state: absent
        allow_service:
          - tcp:443
        provider:
          password: secret
          server: lb.mydomain.com
          user: admin
      delegate_to: localhost

    - name: Allow HTTPS and SSH access to this Self IP
      bigip_selfip:
        name: self1
        state: absent
        allow_service:
          - tcp:443
          - tcp:22
        provider:
          password: secret
          server: lb.mydomain.com
          user: admin
      delegate_to: localhost

    - name: Allow all services access to this Self IP
      bigip_selfip:
        name: self1
        state: absent
        allow_service:
          - all
        provider:
          password: secret
          server: lb.mydomain.com
          user: admin
      delegate_to: localhost

    - name: Allow only GRE and IGMP protocols access to this Self IP
      bigip_selfip:
        name: self1
        state: absent
        allow_service:
          - gre:0
          - igmp:0
        provider:
          user: admin
          password: secret
          server: lb.mydomain.com
      delegate_to: localhost

    - name: Allow all TCP, but no other protocols access to this Self IP
      bigip_selfip:
        name: self1
        state: absent
        allow_service:
          - tcp:0
        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
--- | --- | ---
address string | changed | The address for the Self IP Sample: 192.0.2.10
allow_service list | changed | Services that allowed via this Self IP Sample: ['igmp:0', 'tcp:22', 'udp:53']
name string | created | The name of the Self IP Sample: self1
netmask string | changed | The netmask of the Self IP Sample: 255.255.255.0
traffic_group string | changed | The traffic group that the Self IP is a member of Sample: traffic-group-local-only
vlan string | changed | The VLAN set on the Self IP Sample: vlan1

## Status

- This module is guaranteed to have backward compatible interface changes going forward. [stableinterface]

- This module is maintained by an Ansible Partner. [certified]

### Authors

- Tim Rupp (@caphrim007)

- Wojciech Wypior (@wojtek0806)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.