cisco.intersight.intersight_domain module – Manage UCS Domain Profiles in Cisco Intersight

api_key_id

string / required

Public API Key ID associated with the private key.

If not set, the value of the INTERSIGHT_API_KEY_ID environment variable is used.

api_private_key

path / required

Filename (absolute path) or string of PEM formatted private key data to be used for Intersight API authentication.

If a string is used, Ansible vault should be used to encrypt string data.

Ex. ansible-vault encrypt_string --vault-id tme@/Users/dsoper/Documents/vault_password_file ‘-----BEGIN EC PRIVATE KEY-----

<your private key data>

-----END EC PRIVATE KEY-----’

If not set, the value of the INTERSIGHT_API_PRIVATE_KEY environment variable is used.

api_uri

string

URI used to access the Intersight API.

If not set, the value of the INTERSIGHT_API_URI environment variable is used.

Default: "https://intersight.com/api/v1"

assigned_switch_a_serial

string

The serial number of the Fabric Interconnect to assign to SwitchProfile A.

Resolved via the /network/ElementSummaries API endpoint using the Serial field.

assigned_switch_b_serial

string

The serial number of the Fabric Interconnect to assign to SwitchProfile B.

Resolved via the /network/ElementSummaries API endpoint using the Serial field.

auditd_policy

string

Name of the Audit Log Policy to associate with both Fabric Interconnects.

certificate_management_policy

string

Name of the Certificate Management Policy to associate with both Fabric Interconnects.

description

aliases: descr

string

The user-defined description of the UCS Domain Profile.

ldap_policy

string

Name of the LDAP Policy to associate with both Fabric Interconnects.

name

string / required

The name assigned to the UCS Domain Profile.

The name must be between 1 and 62 alphanumeric characters, allowing special characters :-_.

SwitchProfiles are automatically named {name}-A and {name}-B.

network_connectivity_policy

string

Name of the Network Connectivity (DNS) Policy to associate with both Fabric Interconnects.

ntp_policy

string

Name of the NTP Policy to associate with both Fabric Interconnects.

organization

string

The name of the Organization this resource is assigned to.

Profiles and Policies that are created within a Custom Organization are applicable only to devices in the same Organization.

Default: "default"

port_policy_fi_a

string

Name of the Port Policy to associate with Fabric Interconnect A.

port_policy_fi_b

string

Name of the Port Policy to associate with Fabric Interconnect B.

snmp_policy

string

Name of the SNMP Policy to associate with both Fabric Interconnects.

state

string

If present, will verify the resource is present and will create if needed.

If absent, will verify the resource is absent and will delete if needed.

Choices:

• "present" ← (default)
• "absent"

switch_control_policy

string

Name of the Switch Control Policy to associate with both Fabric Interconnects.

syslog_policy

string

Name of the Syslog Policy to associate with both Fabric Interconnects.

system_qos_policy

string

Name of the System QoS Policy to associate with both Fabric Interconnects.

This policy is mandatory for UCS Domain Profiles.

tags

list / elements=dictionary

List of tags in Key:<user-defined key> Value:<user-defined value> format.

use_proxy

boolean

If no, it will not use a proxy, even if one is defined in an environment variable on the target hosts.

Choices:

• false
• true ← (default)

validate_certs

boolean

Boolean control for verifying the api_uri TLS certificate

Choices:

• false
• true ← (default)

vlan_policy_fi_a

string

Name of the VLAN Policy to associate with Fabric Interconnect A.

vlan_policy_fi_b

string

Name of the VLAN Policy to associate with Fabric Interconnect B.

vsan_policy_fi_a

string

Name of the VSAN Policy to associate with Fabric Interconnect A.

vsan_policy_fi_b

string

Name of the VSAN Policy to associate with Fabric Interconnect B.

api_response

dictionary

The API response output returned by the SwitchClusterProfile resource.

Returned: always

Sample: {"api_response": {"Name": "Domain-01", "ObjectType": "fabric.SwitchClusterProfile", "Organization": {"Moid": "675450ee69726530014753e2", "ObjectType": "organization.Organization"}, "Tags": [{"Key": "Environment", "Value": "Production"}]}}