Ansible Role: BIG-IQ Onboard
Performs a basic series of on-boarding steps to bootstrap a BIG-IQ system to the point that it can accept configuration.
Requirements
None.
Host Variables
Host varibales are listed below:
haprimary=True
haprimary=False
Add variable to host when using role to configure BIG-IQ CM. If configuring 2 hosts and want to establish HA pair, add haprimary=True to primary BIG-IQ host and haprimary=False to Secondary BIG-IP host.
Role Variables
Available variables are listed below. For their default values, see defaults/main.yml:
bigiq_onboard_server: localhost
bigiq_onboard_server_port: 443
bigiq_onboard_user: admin
bigiq_onboard_password: secret
bigiq_onboard_validate_certs: no
bigiq_onboard_transport: rest
bigiq_onboard_timeout: 120
Establishes initial connection to your BIG-IQ. These values are substituted into
your provider module parameter.
bigiq_onboard_new_root_password:
bigiq_onboard_old_root_password: default
bigiq_onboard_new_admin_password:
bigiq_onboard_old_admin_password: admin
Parameters used to change the default admin and root accounts on the BIG-IQ during
onboarding. If you do not want to change the passwords, leave the new variables
empty.
bigiq_onboard_node_type: cm
Control the type of the BIG-IQ node. There are two types; cm and dcd. If you
do not specify a type, the default will be cm.
bigiq_onboard_master_passphrase:
Sets the master password for the BIG-IQ. This value is used for encryption/decryption of fields that BIG-IQ uses. This must meet certain complexity requirements before BIG-IQ will accept it; 16 characters long, and must contain at least one uppercase letter, lower case letter, number, and special character.
bigiq_onboard_dns_nameservers:
- 8.8.8.8
DNS servers that the BIG-IQ will use for name resolution
bigiq_onboard_dns_search:
- localhost
DNS search domains
bigiq_onboard_ntp_servers:
- time.nist.gov
NTP configuration
bigiq_onboard_timezone: America/Los_Angeles
The timezone to set on the BIG-IQ device. This timezone should be specified in the "TZ" format as seen here
bigiq_onboard_license_key:
License key to use to license the BIG-IQ device. If you do not wish to license your device, leave this field empty.
bigiq_onboard_hostname: foo.bar.com
Specifies the hostname of the BIG-IQ device. By default, this setting is commented out. This means that the BIG-IQ will default to a generic hostname. By specifying this value to the role, you can override this default generic
bigiq_onboard_discovery_address: 1.2.3.4/32
Specifies a custom discovery address to create. The address will be created as a Self IP and then the Self IP will be assigned as the discovery address. Specifying an address will also enforce the creation of a default VLAN named 'internal'.
This IP Address must include the subnet in CIDR form, as shown in the example above.
bigiq_onboard_set_basic_auth: false
Allows you to enable basic authentication on the BIG-IQ. This is nearly always a "Bad Idea" and so by default, it is disabled. The cases where you would want to use this mainly come down to debugging and testing.
Dependencies
None.
Example Playbook
- name: Set up a CM BIG-IQ
hosts: bigiq
vars_files:
- vars/main.yml
roles:
- { role: f5devcentral.bigiq_onboard }
Inside vars/main.yml:
bigiq_onboard_server: bigiq01.domain.org
bigiq_onboard_password: secret
bigiq_onboard_new_root_password: New_Admin_Secret123
bigiq_onboard_old_root_password: default
bigiq_onboard_new_admin_password: New_Root_Secret123
bigiq_onboard_old_admin_password: admin
bigiq_onboard_master_passphrase: M@sterPassphrase1234
bigiq_onboard_dns_nameservers:
- 10.10.10.10
bigiq_onboard_dns_search:
- domain.org
bigiq_onboard_timezone: America/Los_Angeles
bigiq_onboard_license_key: XXXXX-XXXXX-XXXXX-XXXXX-XXXXXXX
License
Apache
Author Information
This role was created in 2018 by Tim Rupp.
This role was modified in 2019 by Greg Crosby.
Credits
A special thanks to Jeff Geerling (@geerlingguy) for the molecule test examples.