PARALLAX

intersight_mac_pool_info

Gather information about MAC Pool in Cisco Intersight

Collection: cisco.intersight

Full Name: cisco.intersight.intersight_mac_pool_info

Synopsis

Gather information about MAC Pool in Cisco Intersight

Parameters

NameTypeRequiredDefaultDescription
api_private_keystringFilename (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—– —–END EC PRIVATE KEY—–’ If not set, the value of the INTERSIGHT_API_PRIVATE_KEY environment variable is used. Required if I(api_bearer_token) is not provided. Secret value; omitted from logs and results.
api_uristringhttps://intersight.com/api/v1URI used to access the Intersight API. If not set, the value of the INTERSIGHT_API_URI environment variable is used.
api_key_idstringPublic 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_tokenstringBearer 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_certsbooltrueBoolean control for verifying the api_uri TLS certificate
use_proxybooltrueIf C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts.
organizationstringThe name of the organization that will have information gathered from.
namestringThe name of the MAC Pool that will have information gathered from.

Example

yaml
- cisco.intersight.intersight_mac_pool_info:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    name: mac_pool_1
  name: Fetch mac pool information by name

- cisco.intersight.intersight_mac_pool_info:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
  name: Fetch all mac pool information
Search
    ↑ ↓ move↵ openesc close