cisco.aci.aci_subject_label module – Manage Subject Labels (vz:ConsSubjLbl and vz:ProvSubjLbl)

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

Synopsis

  • Manage Subject Labels 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"

ap

aliases: app_profile, app_profile_name, application_profile, application_profile_name

string

The name of the Application Profile.

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.

complement

boolean

Whether complement is enabled on the Subject Label.

The APIC defaults to false when unset during creation.

Choices:

  • false

  • true

contract

aliases: contract_name

string

The name of the Contract.

description

aliases: descr

string

The description for the Subject Label.

epg

aliases: epg_name

string

The name of the End Point Group.

esg

aliases: esg_name

string

The name of the Endpoint Security Group.

external_epg

aliases: extepg, extepg_name, external_epg_name

string

The name of the External End Point Group.

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.

l2out

aliases: l2out_name

string

The name of the L2Out.

l3out

aliases: l3out_name

string

The name of the L3Out.

name_alias

string

The alias for the current object. This relates to the nameAlias field in ACI.

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.

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.

state

string

Use present or absent for adding or removing.

Use query for listing an object or multiple objects.

Choices:

  • "absent"

  • "present" ← (default)

  • "query"

subject

aliases: subject_name

string

The name of the Subject.

subject_label

aliases: subject_label_name, name, label

string

The name of the Subject Label.

subject_label_type

aliases: type

string / required

Determines the type of the Subject Label.

Choices:

  • "consumer"

  • "provider"

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

tag

string

The color of a policy label of the Subject Label.

The APIC defaults to yellow-green when unset during creation.

Choices:

  • "alice_blue"

  • "antique_white"

  • "aqua"

  • "aquamarine"

  • "azure"

  • "beige"

  • "bisque"

  • "black"

  • "blanched_almond"

  • "blue"

  • "blue_violet"

  • "brown"

  • "burlywood"

  • "cadet_blue"

  • "chartreuse"

  • "chocolate"

  • "coral"

  • "cornflower_blue"

  • "cornsilk"

  • "crimson"

  • "cyan"

  • "dark_blue"

  • "dark_cyan"

  • "dark_goldenrod"

  • "dark_gray"

  • "dark_green"

  • "dark_khaki"

  • "dark_magenta"

  • "dark_olive_green"

  • "dark_orange"

  • "dark_orchid"

  • "dark_red"

  • "dark_salmon"

  • "dark_sea_green"

  • "dark_slate_blue"

  • "dark_slate_gray"

  • "dark_turquoise"

  • "dark_violet"

  • "deep_pink"

  • "deep_sky_blue"

  • "dim_gray"

  • "dodger_blue"

  • "fire_brick"

  • "floral_white"

  • "forest_green"

  • "fuchsia"

  • "gainsboro"

  • "ghost_white"

  • "gold"

  • "goldenrod"

  • "gray"

  • "green"

  • "green_yellow"

  • "honeydew"

  • "hot_pink"

  • "indian_red"

  • "indigo"

  • "ivory"

  • "khaki"

  • "lavender"

  • "lavender_blush"

  • "lawn_green"

  • "lemon_chiffon"

  • "light_blue"

  • "light_coral"

  • "light_cyan"

  • "light_goldenrod_yellow"

  • "light_gray"

  • "light_green"

  • "light_pink"

  • "light_salmon"

  • "light_sea_green"

  • "light_sky_blue"

  • "light_slate_gray"

  • "light_steel_blue"

  • "light_yellow"

  • "lime"

  • "lime_green"

  • "linen"

  • "magenta"

  • "maroon"

  • "medium_aquamarine"

  • "medium_blue"

  • "medium_orchid"

  • "medium_purple"

  • "medium_sea_green"

  • "medium_slate_blue"

  • "medium_spring_green"

  • "medium_turquoise"

  • "medium_violet_red"

  • "midnight_blue"

  • "mint_cream"

  • "misty_rose"

  • "moccasin"

  • "navajo_white"

  • "navy"

  • "old_lace"

  • "olive"

  • "olive_drab"

  • "orange"

  • "orange_red"

  • "orchid"

  • "pale_goldenrod"

  • "pale_green"

  • "pale_turquoise"

  • "pale_violet_red"

  • "papaya_whip"

  • "peachpuff"

  • "peru"

  • "pink"

  • "plum"

  • "powder_blue"

  • "purple"

  • "red"

  • "rosy_brown"

  • "royal_blue"

  • "saddle_brown"

  • "salmon"

  • "sandy_brown"

  • "sea_green"

  • "seashell"

  • "sienna"

  • "silver"

  • "sky_blue"

  • "slate_blue"

  • "slate_gray"

  • "snow"

  • "spring_green"

  • "steel_blue"

  • "tan"

  • "teal"

  • "thistle"

  • "tomato"

  • "turquoise"

  • "violet"

  • "wheat"

  • "white"

  • "white_smoke"

  • "yellow"

  • "yellow_green"

tenant

aliases: tenant_name

string

The name of the Tenant.

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.

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 vz:ConsSubjLbl and (vz:ProvSubjLbl).

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 Subject Label on a Contract Subject
  cisco.aci.aci_subject_label:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    contract: web
    subject: web_subject
    subject_label: web_subject_label
    subject_type: consumer
    state: present
  delegate_to: localhost

- name: Add a Subject Label on a L2Out External EPG
  cisco.aci.aci_subject_label:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    l2out: l2out_name
    external_epg: external_epg_name
    subject_label: l2out_subject_label
    subject_type: consumer
    state: present
  delegate_to: localhost

- name: Add a Subject Label on a L3Out External EPG
  cisco.aci.aci_subject_label:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    l3out: l3out_name
    external_epg: external_epg_name
    subject_label: l3out_subject_label
    subject_type: consumer
    state: present
  delegate_to: localhost

- name: Add a Subject Label on a L3Out External EPG Contract
  cisco.aci.aci_subject_label:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    l3out: l3out_name
    external_epg: external_epg_name
    contract: web
    subject_label: l3out_subject_label
    subject_type: consumer
    state: present
  delegate_to: localhost

- name: Add a Subject Label on a ESG
  cisco.aci.aci_subject_label:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    ap: app_profile_name
    esg: esg_name
    subject_label: esg_subject_label
    subject_type: consumer
    state: present
  delegate_to: localhost

- name: Add a Subject Label on a EPG
  cisco.aci.aci_subject_label:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    ap: app_profile_name
    epg: epg_name
    subject_label: epg_subject_label
    subject_type: consumer
    state: present
  delegate_to: localhost

- name: Add a Subject Label on a EPG Contract
  cisco.aci.aci_subject_label:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    ap: app_profile_name
    epg: epg_name
    contract: web
    subject_label: epg_subject_label
    subject_type: consumer
    state: present
  delegate_to: localhost

- name: Query a Subject Label on a Contract Subject
  cisco.aci.aci_subject_label:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    contract: web
    subject: web_subject
    subject_label: web_subject_label
    subject_type: consumer
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all Subject Labels
  cisco.aci.aci_subject_label:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost
  register: query_result

- name: Remove a Subject Label on a Contract Subject
  cisco.aci.aci_subject_label:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    contract: web
    subject: web_subject
    subject_label: web_subject_label
    subject_type: consumer
    state: absent
  delegate_to: localhost

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 foo\"/></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

  • Mark Ciecior (@markciecior)

  • Akini Ross (@akinross)