aci_access_switch_policy_group
Manage access switch policy groups on Cisco ACI
Collection: cisco.aci
Full Name: cisco.aci.aci_access_switch_policy_group
Synopsis
Manage access switch policy groups on Cisco ACI
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| annotation | string | orchestrator:ansible | User-defined string for annotating an object. If the value is not specified in the task, the value of environment variable C(ACI_ANNOTATION) will be used instead. If the value is not specified in the task and environment variable C(ACI_ANNOTATION) then the default value will be used. | |
| bfd_ipv4_policy | string | The BFD IPv4 policy bound to the access switch policy group. The APIC defaults to C("") 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 C("") 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 I(switch_type=leaf). The APIC defaults to C("") 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 I(switch_type=leaf). The APIC defaults to C("") 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 C("") which results in the target DN set to the default policy when unset during creation. | ||
| certificate_name | string | The X.509 certificate name attached to the APIC AAA user used for signature-based authentication. If a C(private_key) filename was provided, this defaults to the C(private_key) basename, without extension. If PEM-formatted content was provided for C(private_key), this defaults to the C(username) value. If the value is not specified in the task, the value of environment variable C(ACI_CERTIFICATE_NAME) will be used instead. | ||
| copp_policy | string | The CoPP policy bound to the access switch policy group. The APIC defaults to C("") 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 C("") 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 I(switch_type=leaf). The APIC defaults to C("") 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 I(switch_type=leaf). The APIC defaults to C("") 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 I(switch_type=leaf). The APIC defaults to C("") 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 I(switch_type=leaf). The APIC defaults to C("") 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 I(switch_type=leaf). The APIC defaults to C("") which results in the target DN set to the default policy when unset during creation. | ||
| host | 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 C(ACI_HOST) will be used instead. | ||
| lldp_policy | string | The LLDP policy bound to the access switch policy group. The APIC defaults to C("") 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 I(switch_type=leaf). The APIC defaults to C("") which results in the target DN set to the default policy when unset during creation. | ||
| name | 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 I(switch_type=leaf). The APIC defaults to C("") 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 I(switch_type=leaf). The APIC defaults to C("") which results in the target DN set to the default policy when unset during creation. | ||
| output_level | string | normal | Influence the output of this ACI module. C(normal) means the standard output, incl. C(current) dict C(info) adds informational output, incl. C(previous), C(proposed) and C(sent) dicts C(debug) adds debugging output, incl. C(filter_string), C(method), C(response), C(status) and C(url) information If the value is not specified in the task, the value of environment variable C(ACI_OUTPUT_LEVEL) will be used instead. | |
| 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 C(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 C(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 C(ACI_OWNER_TAG) will be used instead. | ||
| password | string | The password to use for authentication. This option is mutual exclusive with C(private_key). If C(private_key) is provided too, it will be used instead. If the value is not specified in the task, the value of environment variables C(ACI_PASSWORD) or C(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 I(switch_type=leaf). The APIC defaults to C("") which results in the target DN set to the default policy when unset during creation. | ||
| port | int | Port number to be used for REST connection. The default value depends on parameter C(use_ssl). If the value is not specified in the task, the value of environment variable C(ACI_PORT) will be used instead. | ||
| private_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 C(certificate_name) that is used. This option is mutual exclusive with C(password). If C(password) is provided too, it will be ignored. If the value is not specified in the task, the value of environment variable C(ACI_PRIVATE_KEY) or C(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 I(switch_type=leaf). The APIC defaults to C("") 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 I(switch_type=leaf). The APIC defaults to C("") which results in the target DN set to the default policy when unset during creation. | ||
| state | string | present | Use C(present) or C(absent) for adding or removing. Use C(query) for listing an object or multiple objects. | |
| suppress_previous | bool | If C(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 C(ACI_SUPPRESS_PREVIOUS) will be used instead. The default value is C(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. | ||
| suppress_verification | bool | If C(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 C(ACI_SUPPRESS_VERIFICATION) will be used instead. The default value is C(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. | ||
| switch_type | string | yes | Whether this is a leaf or spine policy group | |
| 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 I(switch_type=leaf). The APIC defaults to C("") which results in the target DN set to the default policy when unset during creation. | ||
| timeout | int | The socket level timeout in seconds. If the value is not specified in the task, the value of environment variable C(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 C("") which results in the target DN set to the default policy when unset during creation. | ||
| use_proxy | bool | If C(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 C(ACI_USE_PROXY) will be used instead. The default value is true. | ||
| use_ssl | bool | If C(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 C(ACI_USE_SSL) will be used instead. The default value is true when the connection is local. | ||
| username | string | The username to use for authentication. If the value is not specified in the task, the value of environment variables C(ACI_USERNAME) or C(ANSIBLE_NET_USERNAME) will be used instead. The default value is admin. | ||
| validate_certs | bool | If C(false), SSL certificates will not be validated. This should only set to C(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 C(ACI_VALIDATE_CERTS) will be used instead. The default value is true. |
Example
yaml
- {"cisco.aci.aci_access_switch_policy_group": {"bfd_ipv4_policy": "example_bfd_ipv4_policy", "bfd_ipv6_policy": "example_bfd_ipv6_policy", "cdp_policy": "example_cdp_policy", "copp_policy": "example_copp_policy", "copp_pre_filter_policy": "example_copp_pre_filter_policy", "equipment_flash_policy": "example_equipment_flash_policy", "fast_link_failover_policy": "example_fast_link_failover_policy", "fibre_channel_node_policy": "example_fibre_channel_node_policy", "fibre_channel_san_policy": "example_fibre_channel_san_policy", "forward_scale_profile_policy": "example_forward_scale_profile_policy", "host": "apic", "lldp_policy": "example_lldp_policy", "monitoring_policy": "example_monitoring_policy", "name": "ansible_pol_grp_spine", "node_802_1x_authentication_policy": "example_node_802_1x_authentication_policy", "password": "SomeSecretPassword", "poe_node_policy": "example_poe_node_policy", "spanning_tree_policy": "example_spanning_tree_policy", "state": "present", "switch_type": "leaf", "username": "admin"}, "delegate_to": "localhost", "name": "Create Leaf Access Switch Policy Group"}
- {"cisco.aci.aci_access_switch_policy_group": {"bfd_ipv4_policy": "example_bfd_ipv4_policy", "bfd_ipv6_policy": "example_bfd_ipv6_policy", "cdp_policy": "example_cdp_policy", "copp_policy": "example_copp_policy", "copp_pre_filter_policy": "example_copp_pre_filter_policy", "host": "apic", "lldp_policy": "example_lldp_policy", "name": "ansible_pol_grp_leaf", "password": "SomeSecretPassword", "state": "present", "switch_type": "spine", "username": "admin"}, "delegate_to": "localhost", "name": "Create Spine Access Switch Policy Group"}
- {"cisco.aci.aci_access_switch_policy_group": {"host": "apic", "name": "ansible_pol_grp_leaf", "password": "SomeSecretPassword", "state": "absent", "switch_type": "leaf", "username": "admin"}, "delegate_to": "localhost", "name": "Delete Leaf Access Switch Policy Group"}
- {"cisco.aci.aci_access_switch_policy_group": {"host": "apic", "name": "ansible_pol_grp_leaf", "password": "SomeSecretPassword", "state": "query", "switch_type": "leaf", "username": "admin"}, "delegate_to": "localhost", "name": "Query Leaf Access Switch Policy Group", "register": "query_result"}
- {"cisco.aci.aci_access_switch_policy_group": {"host": "apic", "password": "SomeSecretPassword", "state": "query", "switch_type": "leaf", "username": "admin"}, "delegate_to": "localhost", "name": "Query All Leaf Access Switch Policy Groups", "register": "query_result"}