intersight_domain

Manage UCS Domain Profiles in Cisco Intersight

Collection: cisco.intersight

Full Name: cisco.intersight.intersight_domain

Synopsis

Manage UCS Domain Profiles in Cisco Intersight

Parameters

Name	Type	Required	Default	Description
api_private_key	string			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—– —–END EC PRIVATE KEY—–’ If not set, the value of the INTERSIGHT_API_PRIVATE_KEY environment variable is used. Required if I(api_bearer_token) is not provided. Secret value; omitted from logs and results.
api_uri	string		`https://intersight.com/api/v1`	URI used to access the Intersight API. If not set, the value of the INTERSIGHT_API_URI environment variable is used.
api_key_id	string			Public API Key ID associated with the private key. If not set, the value of the INTERSIGHT_API_KEY_ID environment variable is used. Required if I(api_bearer_token) is not provided.
api_bearer_token	string			Bearer token for OAuth2 authentication with the Intersight API. When provided, I(api_key_id) and I(api_private_key) are not required and the C(cryptography) Python library is not needed. If not set, the value of the INTERSIGHT_API_BEARER_TOKEN environment variable is used. Secret value; omitted from logs and results.
validate_certs	bool		`true`	Boolean control for verifying the api_uri TLS certificate
use_proxy	bool		`true`	If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts.
state	string		`present`	If C(present), will verify the resource is present and will create if needed. If C(absent), will verify the resource is absent and will delete if needed. Choices: `present`, `absent`
organization	string		`default`	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.
name	string	yes		The name assigned to the UCS Domain Profile. The name must be between 1 and 64 alphanumeric characters, allowing special characters :-_. SwitchProfiles are automatically named C({name}-A) and C({name}-B).
description	string			The user-defined description of the UCS Domain Profile.
tags	list			List of tags in Key: Value: format.
assigned_switch_a_serial	string			The serial number of the Fabric Interconnect to assign to SwitchProfile A. Resolved via the C(/network/ElementSummaries) API endpoint using the C(Serial) field.
assigned_switch_b_serial	string			The serial number of the Fabric Interconnect to assign to SwitchProfile B. Resolved via the C(/network/ElementSummaries) API endpoint using the C(Serial) field.
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.
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.
ntp_policy	string			Name of the NTP Policy to associate with both Fabric Interconnects.
syslog_policy	string			Name of the Syslog Policy to associate with both Fabric Interconnects.
network_connectivity_policy	string			Name of the Network Connectivity (DNS) Policy to associate with both Fabric Interconnects.
snmp_policy	string			Name of the SNMP Policy to associate with both Fabric Interconnects.
ldap_policy	string			Name of the LDAP Policy to associate with both Fabric Interconnects.
certificate_management_policy	string			Name of the Certificate Management 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.
auditd_policy	string			Name of the Audit Log Policy to associate with both Fabric Interconnects.
switch_control_policy	string			Name of the Switch Control Policy to associate with both Fabric Interconnects.

Example

yaml

- cisco.intersight.intersight_domain:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    description: Basic domain profile
    name: Domain-01
    organization: default
    state: present
    system_qos_policy: Default-QoS
  name: Create a basic UCS Domain Profile

- cisco.intersight.intersight_domain:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    assigned_switch_a_serial: FDO23456ABC
    assigned_switch_b_serial: FDO23456DEF
    description: Full domain profile
    name: Domain-01
    ntp_policy: NTP-Corp
    organization: default
    port_policy_fi_a: Port-Policy-A
    port_policy_fi_b: Port-Policy-B
    snmp_policy: SNMP-Monitor
    state: present
    switch_control_policy: Switch-Control
    syslog_policy: Syslog-Corp
    system_qos_policy: QoS-Default
    vlan_policy_fi_a: VLAN-Policy-A
    vlan_policy_fi_b: VLAN-Policy-B
    vsan_policy_fi_a: VSAN-Policy-A
    vsan_policy_fi_b: VSAN-Policy-B
  name: Create a UCS Domain Profile with switch assignments and policies

- cisco.intersight.intersight_domain:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    name: Domain-01
    state: absent
  name: Delete a UCS Domain Profile