cm_device_info – Collect information from CM devices¶
New in version 1.0.0.
Parameters¶
| Parameter | Choices/Defaults | Configuration | Comments |
|---|---|---|---|
|
gather_subset
list
/ elements=string / required
|
|
When supplied, this argument restricts the information returned to a given subset.
You can specify a list of values to include a larger subset.
Values can also be used with an initial
! to specify that a specific subset should not be collected.aliases: include |
Examples¶
- name: Collect users and files information on CM device
cm_device_info:
gather_subset:
- users
- files
- name: Collect all CM device information
cm_device_info:
gather_subset:
- all
- name: Collect all CM device information except managed-devices
cm_device_info:
gather_subset:
- all
- "!managed-devices"
Return Values¶
The following are the fields unique to this module:
| Key | Returned | Description | |||
|---|---|---|---|---|---|
|
files
complex
|
When files is specified in gather_subset. |
Information about files stored on the CM platform.
Sample:
hash/dictionary of values
|
|||
|
description
string
|
queried |
Description of the file stored on the CM device.
Sample:
this is a new file
|
|||
|
file_name
string
|
queried |
Name of the file stored on the CM device.
Sample:
foo_file
|
|||
|
file_size
integer
|
queried |
File size in bytes.
Sample:
885694
|
|||
|
hash
string
|
queried |
The system generated HASH of the file.
Sample:
080c62dcc1720
|
|||
|
id
string
|
queried |
The system generated UUID of the file.
Sample:
1b0c260c-fc5c-4b82-a781-09eac76cdd09
|
|||
|
updated
string
|
queried |
The timestamp of when the file has been last updated.
Formatted in the ISO8601 format.
Sample:
2023-09-05T12:45:04.871517Z
|
|||
|
managed_devices
complex
|
When managed-devices is specified in gather_subset. |
Information about BIG-IP Next instances managed by the CM platform.
Sample:
hash/dictionary of values
|
|||
|
address
string
|
queried |
The IP address of the BIG-IP Next instance.
Sample:
192.168.1.1
|
|||
|
files
dictionary
|
queried |
Detailed information on the files uploaded to the BIG-IP Next instance.
Sample:
hash/dictionary of values
|
|||
|
description
string
|
queried |
Description of the file stored on the BIG-IP Next instance.
Sample:
this is a new file
|
|||
|
file_name
string
|
queried |
Name of the file stored on the BIG-IP Next instance.
Sample:
foo_file
|
|||
|
hash
string
|
queried |
The system generated HASH of the file.
Sample:
080c62dcc1720
|
|||
|
id
string
|
queried |
The system generated UUID of the file.
Sample:
1b0c260c-fc5c-4b82-a781-09eac76cdd09
|
|||
|
size
integer
|
queried |
File size in bytes.
Sample:
885694
|
|||
|
uri
string
|
queried |
The system generated URI of the file location.
Sample:
file://opt/f5/mbip/subsystem/csm/shared/persisted/files/f516d6-e0f5243a-ff74-4fe1-8163-7d6e6b4c0cb9
|
|||
|
health
dictionary
|
queried |
Detailed information on the state of the BIG-IP Next instance.
Sample:
hash/dictionary of values
|
|||
|
node_count
integer
|
queried |
The number of nodes that the instance is running on.
Sample:
1
|
|||
|
nodes
complex
|
queried |
Detailed information about each node in BIG-IP Next instance.
|
|||
|
address
string
|
queried |
The IP address of the node in BIG-IP Next instance.
Sample:
192.168.1.1
|
|||
|
hostname
string
|
queried |
The hostname of the node in BIG-IP Next instance.
Sample:
foo.bar.net
|
|||
|
port
integer
|
queried |
The port of the node in BIG-IP Next instance.
Sample:
5443
|
|||
|
state
string
|
queried |
The state of the node in BIG-IP Next instance.
Sample:
UNREACHABLE
|
|||
|
version
string
|
queried |
The version of software running on the node in BIG-IP Next instance.
Sample:
20.0.0-2.94.0+0.0.21
|
|||
|
status
string
|
queried |
Current status of the BIG-IP Next instance.
Sample:
UNKNOWN
|
|||
|
hostname
string
|
queried |
The hostname of the BIG-IP Next instance.
Sample:
foo.bar.net
|
|||
|
id
string
|
queried |
The system generated ID for the managed BIG-IP Next instance.
Sample:
a17209c8-eb8a
|
|||
|
mode
string
|
queried |
The operational mode of the BIG-IP Next instance.
Sample:
STANDALONE
|
|||
|
port
integer
|
queried |
The port on which BIG-IP Next instance is communicating with CM.
Sample:
5443
|
|||
|
version
string
|
queried |
The current software version running on the BIG-IP Next instance.
Sample:
20.0.0-2.94.0+0.0.21
|
|||
|
users
dictionary
|
When users is specified in gather_subset. |
Information about users on the CM platform.
Sample:
hash/dictionary of values
|
|||
|
change_password
boolean
|
queried |
Indicates if user is forced to change password upon next login.
Sample:
True
|
|||
|
email
string
|
queried |
The email address configured for the given user.
Sample:
foo@mail.net
|
|||
|
id
string
|
queried |
The system generated UUID of the user.
Sample:
1b0c260c-fc5c-4b82-a781-09eac76cdd09
|
|||
|
username
string
|
queried |
The username of the user.
Sample:
admin-cm
|
|||