cm_next_discover – Module to Add/Delete BIG-IP Next Instances onto Central Manager¶
New in version 1.0.0.
Synopsis¶
- Module to Add/Discover/Delete
BIG-IP-Next
Instances onto C:ref:`Central Manager <Central Manager**_module>` - Instances to be added are not deployed through CM
Parameters¶
Parameter | Choices/Defaults | Configuration | Comments |
---|---|---|---|
accept_untrusted
boolean
|
|
Option to enable/disable untrusted certificates from discovered BIG-IP Next instances.
|
|
device_ip
string
/ required
|
The ip address of the BIG-IP Next instance to discover and add under CM management.
|
||
device_password
string
/ required
|
The administrator password on the target BIG-IP Next instance.
|
||
device_port
integer
|
Default: 5443
|
The port on which CM can communicate with the BIG-IP Next instance.
|
|
device_user
string
/ required
|
The administrator username on the target BIG-IP Next instance.
|
||
force
boolean
|
|
When
true , re-discovers managed existing BIG-IP Next instance by removing adding the device with the given device_ip .When
false , no device is added if a device with the same device_ip exists. |
|
mgmt_password
string
|
The password the CM uses to manage the target BIG-IP Next instance.
Parameter required when
state is present . |
||
mgmt_user
string
|
The username the CM uses to manage the target BIG-IP Next instance.
Parameter required when
state is present . |
||
state
string
|
|
When
present , ensures the BIG-IP Next instance is discovered and added under CM management.When
absent , ensures the BIG-IP Next instance is removed from CM management. |
|
timeout
integer
|
Default: 300
|
The amount of time to wait for the discover task to finish, in seconds.
The accepted value range is between
10 and 1800 seconds. |
Examples¶
- name: Add BIG-IP Next instance
cm_next_discover:
device_ip: "10.1.1.8"
device_port: 5443
device_user: "admin"
device_password: "Welcome123!"
mgmt_user: 'admin-cm'
mgmt_password: "Welcome123!"
timeout: 600
- name: Add BIG-IP Next instance - force on
cm_next_discover:
device_ip: "10.1.1.8"
device_port: 5443
device_user: "admin"
device_password: "Welcome123!"
mgmt_user: 'admin-cm'
mgmt_password: "Welcome123!"
timeout: 600
force: true
- name: Remove BIG-IP Next Instance
cm_next_discover:
device_ip: "10.1.1.8"
device_user: "admin"
device_password: "Welcome123!"
state: 'absent'
timeout: 600
Return Values¶
The following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
device_ip
string
|
changed |
The ip address of the managed BIG-IP Next instance.
Sample:
192.168.1.1
|
device_port
integer
|
changed |
The port on which CM can communicate with the BIG-IP Next instance.
Sample:
5443
|
device_user
string
|
changed |
The administrator username on the target BIG-IP Next instance.
Sample:
admin
|
mgmt_user
string
|
changed |
The username the CM uses to manage the target BIG-IP Next instance.
Sample:
admin-cm
|