aci_switch_leaf_selector – Bind leaf selectors to switch policy leaf profiles (infra:LeafS, infra:NodeBlk, infra:RsAccNodePGrep) — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# aci_switch_leaf_selector – Bind leaf selectors to switch policy leaf profiles (infra:LeafS, infra:NodeBlk, infra:RsAccNodePGrep)

New in version 2.5.

- Synopsis
- Parameters
- Notes
- See Also
- Examples
- Return Values
- Status

## Synopsis

- Bind leaf selectors (with node block range and policy group) to switch policy leaf profiles 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
description string |  | The description to assign to the `leaf`.
from integer |  | Start of Node Block range. aliases: node_blk_range_from, from_range, range_from
host string / required |  | IP Address or hostname of APIC resolvable by Ansible control host. aliases: hostname
leaf string |  | Name of Leaf Selector. aliases: name, leaf_name, leaf_profile_leaf_name, leaf_selector_name
leaf_node_blk string |  | Name of Node Block range to be added to Leaf Selector of given Leaf Profile. aliases: leaf_node_blk_name, node_blk_name
leaf_node_blk_description string |  | The description to assign to the `leaf_node_blk`
leaf_profile string |  | Name of the Leaf Profile to which we add a Selector. aliases: leaf_profile_name
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.
policy_group string |  | Name of the Policy Group to be added to Leaf Selector of given Leaf Profile. aliases: name, policy_group_name
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
state string | Choices: absent present ← query | Use `present` or `absent` for adding or removing. Use `query` for listing an object or multiple objects.
timeout integer | Default: 30 | The socket level timeout in seconds.
to integer |  | Start of Node Block range. aliases: node_blk_range_to, to_range, range_to
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.

## Notes

Note

- This module is to be used with aci_switch_policy_leaf_profile. One first creates a leaf profile (infra:NodeP) and then creates an associated selector (infra:LeafS),

## 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 infra:LeafS, infra:NodeBlk and infra:RsAccNodePGrp.
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: adding a switch policy leaf profile selector associated Node Block range (w/ policy group)
      aci_switch_leaf_selector:
        host: apic
        username: admin
        password: SomeSecretPassword
        leaf_profile: sw_name
        leaf: leaf_selector_name
        leaf_node_blk: node_blk_name
        from: 1011
        to: 1011
        policy_group: somepolicygroupname
        state: present
      delegate_to: localhost

    - name: adding a switch policy leaf profile selector associated Node Block range (w/o policy group)
      aci_switch_leaf_selector:
        host: apic
        username: admin
        password: SomeSecretPassword
        leaf_profile: sw_name
        leaf: leaf_selector_name
        leaf_node_blk: node_blk_name
        from: 1011
        to: 1011
        state: present
      delegate_to: localhost

    - name: Removing a switch policy leaf profile selector
      aci_switch_leaf_selector:
        host: apic
        username: admin
        password: SomeSecretPassword
        leaf_profile: sw_name
        leaf: leaf_selector_name
        state: absent
      delegate_to: localhost

    - name: Querying a switch policy leaf profile selector
      aci_switch_leaf_selector:
        host: apic
        username: admin
        password: SomeSecretPassword
        leaf_profile: sw_name
        leaf: leaf_selector_name
        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.