intersight_info
Gather information about Intersight
Collection: cisco.intersight
Full Name: cisco.intersight.intersight_info
Synopsis
Gather information about Intersight
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| api_private_key | string | Filename (absolute path) or string of PEM formatted private key data to be used for Intersight API authentication. If a string is used, Ansible vault should be used to encrypt string data. Ex. ansible-vault encrypt_string –vault-id tme@/Users/dsoper/Documents/vault_password_file ‘—–BEGIN EC PRIVATE KEY—– | ||
| api_uri | string | https://intersight.com/api/v1 | URI used to access the Intersight API. If not set, the value of the INTERSIGHT_API_URI environment variable is used. | |
| api_key_id | string | Public API Key ID associated with the private key. If not set, the value of the INTERSIGHT_API_KEY_ID environment variable is used. Required if I(api_bearer_token) is not provided. | ||
| api_bearer_token | string | Bearer token for OAuth2 authentication with the Intersight API. When provided, I(api_key_id) and I(api_private_key) are not required and the C(cryptography) Python library is not needed. If not set, the value of the INTERSIGHT_API_BEARER_TOKEN environment variable is used. Secret value; omitted from logs and results. | ||
| validate_certs | bool | true | Boolean control for verifying the api_uri TLS certificate | |
| use_proxy | bool | true | If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts. | |
| server_names | list | Server names to retrieve information from. An empty list will return all servers. |
Example
yaml
- intersight_info:
api_key_id: 64612d300d0982/64612d300d0b00/64612d300d3650
api_private_key: ~/Downloads/SecretKey.txt
server_names: null
name: Get info for all servers
- intersight_info:
api_key_id: 64612d300d0982/64612d300d0b00/64612d300d3650
api_private_key: ~/Downloads/SecretKey.txt
server_names:
- SJC18-L14-UCS1-1
name: Get info for servers by name