intersight_port_policy_info

Gather information about Cisco Intersight Port Policies

Collection: cisco.intersight

Full Name: cisco.intersight.intersight_port_policy_info

Synopsis

Gather information about Cisco Intersight Port Policies

Parameters

Name	Type	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—– —–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_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.
name	string		Name of the Port Policy to retrieve information for. If not provided, information for all Port Policies will be returned.
organization	string		The name of the Organization to filter policies by. If not provided, policies from all accessible organizations will be returned.

Example

yaml

- cisco.intersight.intersight_port_policy_info:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
  name: Get information about all Port Policies
  register: all_port_policies

- cisco.intersight.intersight_port_policy_info:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    name: port-policy-example
  name: Get information about a specific Port Policy
  register: specific_policy

- cisco.intersight.intersight_port_policy_info:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    organization: production
  name: Get information about Port Policies in a specific organization
  register: org_policies

- cisco.intersight.intersight_port_policy_info:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    name: port-policy-example
    organization: production
  name: Get information about a specific Port Policy in a specific organization
  register: specific_org_policy