cisco.aci.aci_access_switch_policy_group module – Manage Access Switch Policy Groups (infra:AccNodePGrp and infra:SpineAccNodePGrp).

Note

This module is part of the cisco.aci collection (version 2.10.1).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install cisco.aci.

To use it in a playbook, specify: cisco.aci.aci_access_switch_policy_group.

Synopsis

• Manage Access Switch Policy Groups on Cisco ACI fabrics.

Parameters

Parameter	Comments
annotation string	User-defined string for annotating an object. If the value is not specified in the task, the value of environment variable ACI_ANNOTATION will be used instead. If the value is not specified in the task and environment variable ACI_ANNOTATION then the default value will be used. Default: "orchestrator:ansible"
bfd_ipv4_policy string	The BFD IPv4 policy bound to the access switch policy group. The APIC defaults to "" which results in the target DN set to the default policy when unset during creation.
bfd_ipv6_policy string	The BFD IPv6 policy bound to the access switch policy group. The APIC defaults to "" which results in the target DN set to the default policy when unset during creation.
bfd_multihop_ipv4_policy string	The BFD multihop IPv4 policy bound to the access switch policy group. Only available in APIC version 5.x or later. Only available when switch_type=leaf. The APIC defaults to "" which results in the target DN set to the default policy when unset during creation.
bfd_multihop_ipv6_policy string	The BFD multihop IPv6 policy bound to the access switch policy group. Only available in APIC version 5.x or later. Only available when switch_type=leaf. The APIC defaults to "" which results in the target DN set to the default policy when unset during creation.
cdp_policy string	The CDP policy bound to the access switch policy group. The APIC defaults to "" which results in the target DN set to the default policy when unset during creation.
certificate_name aliases: cert_name string	The X.509 certificate name attached to the APIC AAA user used for signature-based authentication. If a private_key filename was provided, this defaults to the private_key basename, without extension. If PEM-formatted content was provided for private_key, this defaults to the username value. If the value is not specified in the task, the value of environment variable ACI_CERTIFICATE_NAME will be used instead.
copp_policy string	The CoPP policy bound to the access switch policy group. The APIC defaults to "" which results in the target DN set to the default policy when unset during creation.
copp_pre_filter_policy string	The CoPP pre-filter policy bound to the access switch policy group. The APIC defaults to "" which results in the target DN set to the default policy when unset during creation.
description string	The description of the access switch policy group.
equipment_flash_policy string	The equipment flash policy bound to the access switch policy group. Only available when switch_type=leaf. The APIC defaults to "" which results in the target DN set to the default policy when unset during creation.
fast_link_failover_policy string	The fast link failover policy bound to the access switch policy group. Only available when switch_type=leaf. The APIC defaults to "" which results in the target DN set to the default policy when unset during creation.
fibre_channel_node_policy string	The fibre channel node policy bound to the access switch policy group. Only available when switch_type=leaf. The APIC defaults to "" which results in the target DN set to the default policy when unset during creation.
fibre_channel_san_policy string	The fibre channel SAN policy bound to the access switch policy group. Only available when switch_type=leaf. The APIC defaults to "" which results in the target DN set to the default policy when unset during creation.
forward_scale_profile_policy string	The forward scale profile policy bound to the access switch policy group. Only available when switch_type=leaf. The APIC defaults to "" which results in the target DN set to the default policy when unset during creation.
host aliases: hostname string	IP Address or hostname of APIC resolvable by Ansible control host. If the value is not specified in the task, the value of environment variable ACI_HOST will be used instead.
lldp_policy string	The LLDP policy bound to the access switch policy group. The APIC defaults to "" which results in the target DN set to the default policy when unset during creation.
monitoring_policy string	The monitoring policy bound to the access switch policy group. Only available when switch_type=leaf. The APIC defaults to "" which results in the target DN set to the default policy when unset during creation.
name aliases: policy_group string	The name of the access switch policy group.
netflow_node_policy string	The netflow node policy bound to the access switch policy group. Only available when switch_type=leaf. The APIC defaults to "" which results in the target DN set to the default policy when unset during creation.
node_802_1x_authentication_policy string	The 802.1x node authentication policy bound to the access switch policy group. Only available when switch_type=leaf. The APIC defaults to "" which results in the target DN set to the default policy when unset during creation.
output_level string	Influence the output of this ACI module. normal means the standard output, incl. current dict info adds informational output, incl. previous, proposed and sent dicts debug adds debugging output, incl. filter_string, method, response, status and url information If the value is not specified in the task, the value of environment variable ACI_OUTPUT_LEVEL will be used instead. Choices: "debug" "info" "normal" ← (default)
output_path string	Path to a file that will be used to dump the ACI JSON configuration objects generated by the module. If the value is not specified in the task, the value of environment variable ACI_OUTPUT_PATH will be used instead.
owner_key string	User-defined string for the ownerKey attribute of an ACI object. This attribute represents a key for enabling clients to own their data for entity correlation. If the value is not specified in the task, the value of environment variable ACI_OWNER_KEY will be used instead.
owner_tag string	User-defined string for the ownerTag attribute of an ACI object. This attribute represents a tag for enabling clients to add their own data. For example, to indicate who created this object. If the value is not specified in the task, the value of environment variable ACI_OWNER_TAG will be used instead.
password string	The password to use for authentication. This option is mutual exclusive with private_key. If private_key is provided too, it will be used instead. If the value is not specified in the task, the value of environment variables ACI_PASSWORD or ANSIBLE_NET_PASSWORD will be used instead.
poe_node_policy string	The PoE node policy bound to the access switch policy group. Only available when switch_type=leaf. The APIC defaults to "" which results in the target DN set to the default policy when unset during creation.
port integer	Port number to be used for REST connection. The default value depends on parameter use_ssl. If the value is not specified in the task, the value of environment variable ACI_PORT will be used instead.
private_key aliases: cert_key string	Either a PEM-formatted private key file or the private key content used for signature-based authentication. This value also influences the default certificate_name that is used. This option is mutual exclusive with password. If password is provided too, it will be ignored. If the value is not specified in the task, the value of environment variable ACI_PRIVATE_KEY or ANSIBLE_NET_SSH_KEYFILE will be used instead.
ptp_node_policy string	The PTP node policy bound to the access switch policy group. Only available in APIC version 5.2 or later. Only available when switch_type=leaf. The APIC defaults to "" which results in the target DN set to the default policy when unset during creation.
spanning_tree_policy string	The spanning tree policy bound to the access switch policy group. Only available in APIC version 5.2 or later. Only available when switch_type=leaf. The APIC defaults to "" which results in the target DN set to the default policy when unset during creation.
state string	Use present or absent for adding or removing. Use query for listing an object or multiple objects. Choices: "absent" "present" ← (default) "query"
suppress_previous aliases: no_previous, ignore_previous boolean	If true, a GET to check previous will not be sent before a POST update to APIC. If the value is not specified in the task, the value of environment variable ACI_SUPPRESS_PREVIOUS will be used instead. The default value is false. WARNING - This causes the previous return value to be empty. The previous state of the object will not be checked and the POST update will contain all properties. Choices: false true
suppress_verification aliases: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification boolean	If true, a verifying GET will not be sent after a POST update to APIC. If the value is not specified in the task, the value of environment variable ACI_SUPPRESS_VERIFICATION will be used instead. The default value is false. WARNING - This causes the current return value to be set to the proposed value. The current object including default values will be unverifiable in a single task. Choices: false true
switch_type string / required	Whether this is a leaf or spine policy group Choices: "leaf" "spine"
sync_e_node_policy string	The SyncE node policy bound to the access switch policy group. Only available in APIC version 5.x or later. Only available when switch_type=leaf. The APIC defaults to "" which results in the target DN set to the default policy when unset during creation.
timeout integer	The socket level timeout in seconds. If the value is not specified in the task, the value of environment variable ACI_TIMEOUT will be used instead. The default value is 30.
usb_configuration_policy string	The USB configuration policy bound to the access switch policy group. Only available in APIC version 5.2 or later. The APIC defaults to "" which results in the target DN set to the default policy when unset during creation.
use_proxy boolean	If false, it will not use a proxy, even if one is defined in an environment variable on the target hosts. If the value is not specified in the task, the value of environment variable ACI_USE_PROXY will be used instead. The default value is true. Choices: false true
use_ssl boolean	If false, an HTTP connection will be used instead of the default HTTPS connection. If the value is not specified in the task, the value of environment variable ACI_USE_SSL will be used instead. The default value is true when the connection is local. Choices: false true
username aliases: user string	The username to use for authentication. If the value is not specified in the task, the value of environment variables ACI_USERNAME or ANSIBLE_NET_USERNAME will be used instead. The default value is admin.
validate_certs boolean	If false, SSL certificates will not be validated. This should only set to false when used on personally controlled sites using self-signed certificates. If the value is not specified in the task, the value of environment variable ACI_VALIDATE_CERTS will be used instead. The default value is true. Choices: false true

See Also

See also

APIC Management Information Model reference

More information about the internal APIC class infra:AccNodePGrp and infra:SpineAccNodePGrp.

Cisco ACI Guide

Detailed information on how to manage your ACI infrastructure using Ansible.

Developing Cisco ACI modules

Detailed guide on how to write your own Cisco ACI modules to contribute.

Examples

- name: Create Leaf Access Switch Policy Group
  cisco.aci.aci_access_switch_policy_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: ansible_pol_grp_spine
    switch_type: leaf
    spanning_tree_policy: example_spanning_tree_policy
    bfd_ipv4_policy: example_bfd_ipv4_policy
    bfd_ipv6_policy: example_bfd_ipv6_policy
    fibre_channel_node_policy: example_fibre_channel_node_policy
    poe_node_policy: example_poe_node_policy
    fibre_channel_san_policy: example_fibre_channel_san_policy
    monitoring_policy: example_monitoring_policy
    copp_policy: example_copp_policy
    forward_scale_profile_policy: example_forward_scale_profile_policy
    fast_link_failover_policy: example_fast_link_failover_policy
    node_802_1x_authentication_policy: example_node_802_1x_authentication_policy
    copp_pre_filter_policy: example_copp_pre_filter_policy
    equipment_flash_policy: example_equipment_flash_policy
    cdp_policy: example_cdp_policy
    lldp_policy: example_lldp_policy
    state: present
  delegate_to: localhost

- name: Create Spine Access Switch Policy Group
  cisco.aci.aci_access_switch_policy_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: ansible_pol_grp_leaf
    switch_type: spine
    bfd_ipv4_policy: example_bfd_ipv4_policy
    bfd_ipv6_policy: example_bfd_ipv6_policy
    copp_policy: example_copp_policy
    copp_pre_filter_policy: example_copp_pre_filter_policy
    cdp_policy: example_cdp_policy
    lldp_policy: example_lldp_policy
    state: present
  delegate_to: localhost

- name: Delete Leaf Access Switch Policy Group
  cisco.aci.aci_access_switch_policy_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: ansible_pol_grp_leaf
    switch_type: leaf
    state: absent
  delegate_to: localhost

- name: Query Leaf Access Switch Policy Group
  cisco.aci.aci_access_switch_policy_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: ansible_pol_grp_leaf
    switch_type: leaf
    state: query
  delegate_to: localhost
  register: query_result

- name: Query All Leaf Access Switch Policy Groups
  cisco.aci.aci_access_switch_policy_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    switch_type: leaf
    state: query
  delegate_to: localhost
  register: query_result

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
current list / elements=string	The existing configuration from the APIC after the module has finished Returned: success Sample: [{"fvTenant": {"attributes": {"descr": "Production environment", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]
error dictionary	The error information as returned from the APIC Returned: failure Sample: {"code": "122", "text": "unknown managed object class foo"}
filter_string string	The filter string used for the request Returned: failure or debug Sample: "?rsp-prop-include=config-only"
method string	The HTTP method used for the request to the APIC Returned: failure or debug Sample: "POST"
previous list / elements=string	The original configuration from the APIC before the module has started Returned: info Sample: [{"fvTenant": {"attributes": {"descr": "Production", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]
proposed dictionary	The assembled configuration from the user-provided parameters Returned: info Sample: {"fvTenant": {"attributes": {"descr": "Production environment", "name": "production"}}}
raw string	The raw output returned by the APIC REST API (xml or json) Returned: parse error Sample: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><imdata totalCount=\"1\"><error code=\"122\" text=\"unknown managed object class \"/></imdata>"
response string	The HTTP response from the APIC Returned: failure or debug Sample: "OK (30 bytes)"
sent list / elements=string	The actual/minimal configuration pushed to the APIC Returned: info Sample: {"fvTenant": {"attributes": {"descr": "Production environment"}}}
status integer	The HTTP status from the APIC Returned: failure or debug Sample: 200
url string	The HTTP url used for the request to the APIC Returned: failure or debug Sample: "https://10.11.12.13/api/mo/uni/tn-production.json"

Authors

• Tim Cragg (@timcragg)

• Akini Ross (@akinross)

Collection links

• Issue Tracker
• Repository (Sources)