W3cubDocs

/Ansible

bigip_hostname - Manage the hostname of a BIG-IP.

New in version 2.3.

Synopsis

Manage the hostname of a BIG-IP.

Requirements (on host that executes module)

  • f5-sdk

Options

parameter required default choices comments
hostname
 yes
Hostname of the BIG-IP host.
password
 yes
The password for the user account used to connect to the BIG-IP.
server
 yes
The BIG-IP host.
server_port
(added in 2.2)
 no 443
The BIG-IP server port.
user
 yes
The username to connect to the BIG-IP with. This user must have administrative privileges on the device.
validate_certs
(added in 2.0)
 no True
  • True
  • False
If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.

Examples

- name: Set the hostname of the BIG-IP
  bigip_hostname:
      hostname: "bigip.localhost.localdomain"
      password: "admin"
      server: "bigip.localhost.localdomain"
      user: "admin"
  delegate_to: localhost

Return Values

Common return values are documented here Common Return Values, the following are the fields unique to this module:

name description returned type sample
hostname The new hostname of the device changed string big-ip01.internal

Notes

Note

Requires the f5-sdk Python package on the host. This is as easy as pip install f5-sdk.

This is an Extras Module

For more information on what this means please read Extras Modules

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, developing_test_pr and Developing Modules.

© 2012–2016 Michael DeHaan
© 2016 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/bigip_hostname_module.html