aci_switch_policy_vpc_protection_group – Manage switch policy explicit vPC protection groups (fabric:ExplicitGEp, fabric:NodePEp)

New in version 2.5.

Synopsis

• Manage switch policy explicit vPC protection groups on Cisco ACI fabrics.

Parameters

Parameter	Choices/Defaults	Comments
certificate_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. aliases: cert_name
host string / required		IP Address or hostname of APIC resolvable by Ansible control host. aliases: hostname
output_level string	Choices: debug info normal ←	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
password string / required		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.
port integer		Port number to be used for REST connection. The default value depends on parameter use_ssl.
private_key string / required		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. aliases: cert_key
protection_group string / required		The name of the Explicit vPC Protection Group. aliases: name, protection_group_name
protection_group_id integer / required		The Explicit vPC Protection Group ID. aliases: id
state string	Choices: absent present ← query	Use present or absent for adding or removing. Use query for listing an object or multiple objects.
switch_1_id integer / required		The ID of the first Leaf Switch for the Explicit vPC Protection Group.
switch_2_id integer / required		The ID of the Second Leaf Switch for the Explicit vPC Protection Group.
timeout integer	Default: 30	The socket level timeout in seconds.
use_proxy boolean	Choices: no yes ←	If no, it will not use a proxy, even if one is defined in an environment variable on the target hosts.
use_ssl boolean	Choices: no yes ←	If no, an HTTP connection will be used instead of the default HTTPS connection.
username string	Default: "admin"	The username to use for authentication. aliases: user
validate_certs boolean	Choices: no yes ←	If no, SSL certificates will not be validated. This should only set to no when used on personally controlled sites using self-signed certificates.
vpc_domain_policy string		The vPC domain policy to be associated with the Explicit vPC Protection Group. aliases: vpc_domain_policy_name

See Also

See also

aci_switch_policy_leaf_profile – Manage switch policy leaf profiles (infra:NodeP)

The official documentation on the aci_switch_policy_leaf_profile module.

APIC Management Information Model reference

More information about the internal APIC classes fabric:ExplicitGEp and fabric:NodePEp.

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 vPC Protection Group
  aci_switch_policy_vpc_protection_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    protection_group: leafPair101-vpcGrp
    protection_group_id: 6
    switch_1_id: 1011
    switch_2_id: 1012
    state: present
  delegate_to: localhost

- name: Remove Explicit vPC Protection Group
  aci_switch_policy_vpc_protection_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    protection_group: leafPair101-vpcGrp
    state: absent
  delegate_to: localhost

- name: Query vPC Protection Groups
  aci_switch_policy_vpc_protection_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost
  register: query_result

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

Status

• This module is not guaranteed to have a backwards compatible interface. [preview]
• This module is maintained by an Ansible Partner. [certified]

Authors

• Bruno Calogero (@brunocalogero)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.