PARALLAX

bigip_hostname

Manage the hostname of a BIG-IP

Collection: f5networks.f5_modules

Full Name: f5networks.f5_modules.bigip_hostname

Synopsis

Manage the hostname of a BIG-IP

Parameters

NameTypeRequiredDefaultDescription
providerdictBIG-IP connection options: server, server_port (443), user, password (private aliases pass/pwd), validate_certs (true), transport (rest), timeout, no_f5_teem (false), auth_provider. Fallbacks belong to the execution host.
hostnamestryesRequired hostname. Supplied null becomes empty; booleans/numbers become Python-compatible strings. No DNS validation, trimming or case conversion. Native limit: 4096 UTF8 bytes for desired/current hostname and selected device name. Check mode reads both settings without writes. No source diff is produced. PATCH precedes device mv; rename failure leaves the hostname PATCH applied without rollback.

Example

yaml
- name: Set the hostname of the BIG-IP
  f5networks.f5_modules.bigip_hostname:
    hostname: bigip.localhost.localdomain
    provider:
      user: admin
      password: '{{ bigip_password }}'
      server: lb.mydomain.com
  delegate_to: localhost

- name: Preview a BIG-IP hostname change
  f5networks.f5_modules.bigip_hostname:
    hostname: big-ip01.internal
    provider:
      user: admin
      password: '{{ bigip_password }}'
      server: lb.mydomain.com
  check_mode: true
  delegate_to: localhost
Search
    ↑ ↓ move↵ openesc close