intersight_ethernet_network_control_policy

Ethernet Network Control Policy configuration for Cisco Intersight

Collection: cisco.intersight

Full Name: cisco.intersight.intersight_ethernet_network_control_policy

Synopsis

Ethernet Network Control Policy configuration for 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, Policies, and Pools that are created within a Custom Organization are applicable only to devices in the same Organization.
name	string	yes		The name assigned to the Ethernet Network Control Policy. The name must be between 1 and 64 alphanumeric characters, allowing special characters :-_.
description	string			The user-defined description for the Ethernet Network Control Policy. Description can contain letters(a-z, A-Z), numbers(0-9), hyphen(-), period(.), colon(:), or an underscore(_).
tags	list			List of tags in Key: Value: format.
cdp_enabled	bool		`false`	Enables the CDP on an interface. Cisco Discovery Protocol (CDP) is a proprietary Data Link Layer protocol developed by Cisco Systems.
mac_registration_mode	string		`nativeVlanOnly`	Determines the MAC addresses that have to be registered with the switch. nativeVlanOnly - Register only the MAC addresses learned in the native VLAN. allVlans - Register the MAC addresses learned in all VLANs. Choices: `nativeVlanOnly`, `allVlans`
uplink_fail_action	string		`linkDown`	Determines the state of the virtual interface (vethernet / vfc) on the switch when a suitable uplink is not pinned. linkDown - The vethernet will go down. warning - The vethernet will remain up and will not fail over if uplink connectivity is lost. Important! If the Action on Uplink is set to Warning, the switch will not fail over if uplink connectivity is lost. Choices: `linkDown`, `warning`
forge_mac	string		`allow`	Determines if the MAC forging is allowed or denied on an interface. allow - Allows MAC forging on the interface. deny - Denies MAC forging on the interface. Choices: `allow`, `deny`
lldp_transmit_enabled	bool		`false`	Determines if the LLDP frames can be transmitted by an interface on the switch. Link Layer Discovery Protocol (LLDP) is a vendor-neutral link layer protocol.
lldp_receive_enabled	bool		`false`	Determines if the LLDP frames can be received by an interface on the switch. Link Layer Discovery Protocol (LLDP) is a vendor-neutral link layer protocol.

Example

yaml

- cisco.intersight.intersight_ethernet_network_control_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    description: Default Ethernet Network Control policy
    name: default-network-control-policy
    organization: default
    state: present
  name: Create an Ethernet Network Control Policy with default settings

- cisco.intersight.intersight_ethernet_network_control_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    cdp_enabled: true
    description: Network Control policy with discovery protocols enabled
    forge_mac: deny
    lldp_receive_enabled: true
    lldp_transmit_enabled: true
    mac_registration_mode: allVlans
    name: discovery-enabled-policy
    organization: default
    state: present
    tags:
        - Key: Environment
          Value: Production
    uplink_fail_action: warning
  name: Create an Ethernet Network Control Policy with CDP and LLDP enabled

- cisco.intersight.intersight_ethernet_network_control_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    cdp_enabled: false
    description: Secure Network Control policy with MAC forging denied
    forge_mac: deny
    lldp_receive_enabled: false
    lldp_transmit_enabled: false
    mac_registration_mode: nativeVlanOnly
    name: secure-network-control-policy
    state: present
    uplink_fail_action: linkDown
  name: Create an Ethernet Network Control Policy with strict security settings

- cisco.intersight.intersight_ethernet_network_control_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    name: secure-network-control-policy
    state: absent
  name: Delete an Ethernet Network Control Policy