You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

cisco.aci.aci_fabric_switch_policy_group module – Manage Fabric Switch Policy Group objects.

Note

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

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_fabric_switch_policy_group.

Synopsis

• Manage Fabric Switch Policy Group (fabricLeNodePGrp and fabricSpNodePGrp) configuration on Cisco ACI fabrics.

Parameters

Parameter	Comments
analytics_cluster string	Name of the analytics cluster. Requires analytics_name to be present
analytics_name string	Name of the analytics policy. Requires analytics_cluster to be present
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.
core_export_policy aliases: core, core_export, fabricRsNodeCoreP string	Core Export Policy to attach to this Policy Group
description string	Description for the Leaf Policy Group.
host aliases: hostname string / required	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.
inventory_policy aliases: inventory, fabricRsCallhomeInvPol string	Inventory Policy to attach to this Policy Group
monitoring_policy aliases: monitoring, fabricRsMonInstFabricPol string	Monitoring Policy to attach to this Policy Group
name aliases: policy_group, policy_group_name string	The name of the Leaf Policy Group.
node_control_policy aliases: node_control, fabricRsNodeCtrl string	Node Control Policy to attach to this Policy Group
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.
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.
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.
power_redundancy_policy aliases: power_redundancy, fabricRsPsuInstPol string	Power Redundancy Policy to atttach to this Policy Group
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.
state string	Use present or absent for adding or removing. Use query for listing an object or multiple objects. Choices: absent present ← (default) query
switch_type string / required	Whether this is a leaf or spine policy group Choices: leaf spine
tech_support_export_policy aliases: tech_support, tech_support_export, fabricRsNodeTechSupP string	Tech Support Export Policy to attach to this Policy Group
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. Default: 30
twamp_responder_policy aliases: twamp_responder, fabricRsTwampResponderPol string	TWAMP Responder Policy to attach to this Policy Group
twamp_server_policy aliases: twamp_server, fabricRsTwampServerPol string	TWAMP Server Policy to attach to this Policy Group
use_proxy boolean	If no, 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. Choices: no yes ← (default)
use_ssl boolean	If no, 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. Choices: no yes ← (default)
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. Default: “admin”
validate_certs boolean	If no, SSL certificates will not be validated. This should only set to no 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. Choices: no yes ← (default)

See Also

See also

APIC Management Information Model reference

More information about the internal APIC classes fabricLeNodePGrp and fabricSpNodePGrp.

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: Add a new Fabric Leaf Policy Group
  cisco.aci.aci_fabric_switch_policy_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: my_fabric_leaf_policy_group
    switch_type: leaf
    monitoring_policy: my_monitor_policy
    inventory_policy: my_inv_policy
    state: present
    delegate_to: localhost

- name: Remove existing analytics and monitoring policy bindings from a Policy Group
  cisco.aci.aci_fabric_switch_policy_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: my_fabric_leaf_policy_group
    switch_type: leaf
    monitoring_policy: ""
    analytics_cluster: ""
    analytics_name: ""
    state: present
    delegate_to: localhost

- name: Remove a Fabric Leaf Policy Group
  cisco.aci.aci_fabric_switch_policy_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: my_fabric_leaf_policy_group
    switch_type: leaf
    state: absent
    delegate_to: localhost

- name: Query a Fabric Leaf Policy Group
  cisco.aci.aci_fabric_switch_policy_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: my_fabric_leaf_policy_group
    switch_type: leaf
    state: query
    delegate_to: localhost
    register: query_result

- name: Query all Fabric Leaf Policy Groups
  cisco.aci.aci_fabric_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: “\u003c?xml version=\”1.0\” encoding=\”UTF-8\”?\u003e\u003cimdata totalCount=\”1\”\u003e\u003cerror code=\”122\” text=\”unknown managed object class \”/\u003e\u003c/imdata\u003e”
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)

Collection links

Issue Tracker Repository (Sources)