intersight_lan_connectivity_policy
Manage LAN Connectivity Policies and vNICs for Cisco Intersight
Collection: cisco.intersight
Full Name: cisco.intersight.intersight_lan_connectivity_policy
Synopsis
Manage LAN Connectivity Policies and vNICs 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—– | ||
| 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. Policies created within a Custom Organization are applicable only to devices in the same Organization. Use ‘default’ for the default organization. | |
| name | string | yes | The name assigned to the LAN Connectivity Policy. Must be unique within the organization. The name must be between 1 and 64 alphanumeric characters, allowing special characters :-_. | |
| description | string | The user-defined description for the LAN Connectivity 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: | ||
| target_platform | string | Standalone | The platform type for which the LAN Connectivity policy is intended. Standalone for Standalone servers, FIAttached for fabric interconnect attached servers. Choices: Standalone, FIAttached | |
| azure_qos_enabled | bool | false | Enable Azure QoS for the LAN Connectivity policy. Only applicable when target_platform is ‘FIAttached’. | |
| iqn_allocation_type | string | None | IQN allocation type for the LAN Connectivity policy. Only applicable when target_platform is ‘FIAttached’. Choices: None, Pool, Static | |
| placement_mode | string | custom | Placement mode for vNIC assignment. Only applicable when target_platform is ‘FIAttached’. Choices: custom, auto | |
| iqn_pool_name | string | Relationship to the iSCSI Qualified Name Pool. Required when iqn_allocation_type is ‘Pool’. Only applicable for FIAttached target platform. | ||
| static_iqn_name | string | User provided static iSCSI Qualified Name (IQN) for use as initiator identifiers by iSCSI vNICs in a Fabric Interconnect domain. Required when iqn_allocation_type is ‘Static’. Only applicable for FIAttached target platform. | ||
| vnics | list | List of vNICs to be created and attached to the LAN Connectivity policy. Each vNIC will be configured with the specified network and adapter policies. Required when C(state) is C(present). At least one vNIC must be specified for both Standalone and FIAttached platforms. Nested options: name (str) required; state (str) default=present; placement_slot_id (str); pci_link (int) default=0; uplink_port (int) default=0; order (int) default=0; eth_network_policy_name (str); eth_qos_policy_name (str); eth_adapter_policy_name (str); mac_address_type (str) default=pool; static_mac_address (str); auto_slot_id (bool) default=true; auto_pci_link (bool) default=true; pci_link_assignment_mode (str); auto_vnic_placement_enabled (bool) default=false; pin_group_name (str); connection_type (str) default=none; iscsi_boot_policy_name (str); fabric_eth_network_control_policy_name (str); fabric_eth_network_group_policy_name (str); failover_enabled (bool) default=false; switch_id (str) default=A; mac_pool_name (str); cdn_value (str); cdn_source (str) default=vnic; usnic_settings (dict) {Nested options: count (int) default=0; cos (int) default=5; usnic_adapter_policy_name (str)}; vmq_settings (dict) {Nested options: enabled (bool) default=true; multi_queue_support (bool) default=false; num_interrupts (int) default=16; num_vmqs (int) default=4; num_sub_vnics (int) default=64; vmmq_adapter_policy_name (str)}; sriov_settings (dict) {Nested options: enabled (bool) default=true; vf_count (int) default=64; rx_count_per_vf (int) default=4; tx_count_per_vf (int) default=1; comp_count_per_vf (int) default=5; int_count_per_vf (int) default=8} |
Example
yaml
- cisco.intersight.intersight_lan_connectivity_policy:
api_key_id: '{{ api_key_id }}'
api_private_key: '{{ api_private_key }}'
description: LAN connectivity policy for Standalone servers
name: Standalone-lan-policy
organization: default
state: present
tags:
- Key: Environment
Value: Production
- Key: Site
Value: DataCenter-A
target_platform: Standalone
vnics:
- connection_type: none
eth_adapter_policy_name: default-adapter-policy
eth_network_policy_name: default-network-policy
eth_qos_policy_name: default-qos-policy
name: eth0
order: 0
pci_link: 0
placement_slot_id: "1"
uplink_port: 0
- connection_type: none
eth_adapter_policy_name: performance-adapter-policy
eth_network_policy_name: vlan-network-policy
eth_qos_policy_name: high-qos-policy
name: eth1
order: 1
pci_link: 0
placement_slot_id: "2"
uplink_port: 1
name: Create a LAN Connectivity Policy for Standalone servers
- cisco.intersight.intersight_lan_connectivity_policy:
api_key_id: '{{ api_key_id }}'
api_private_key: '{{ api_private_key }}'
azure_qos_enabled: true
description: LAN connectivity policy for FIAttached servers
iqn_allocation_type: Pool
iqn_pool_name: default-iqn-pool
name: fi-attached-lan-policy
organization: default
placement_mode: custom
state: present
tags:
- Key: Environment
Value: Production
target_platform: FIAttached
vnics:
- auto_pci_link: true
auto_slot_id: true
auto_vnic_placement_enabled: false
cdn_source: vnic
connection_type: none
eth_adapter_policy_name: default-adapter-policy
eth_qos_policy_name: default-qos-policy
fabric_eth_network_control_policy_name: default-network-control
fabric_eth_network_group_policy_name: default-network-group
failover_enabled: false
mac_address_type: pool
mac_pool_name: default-mac-pool
name: vnic-fi-attached
order: 0
state: present
switch_id: A
name: Create a LAN Connectivity Policy for FIAttached servers
- cisco.intersight.intersight_lan_connectivity_policy:
api_key_id: '{{ api_key_id }}'
api_private_key: '{{ api_private_key }}'
azure_qos_enabled: false
description: LAN connectivity policy with static uplink pinning
iqn_allocation_type: None
name: fi-attached-pinned-policy
organization: default
placement_mode: custom
state: present
target_platform: FIAttached
vnics:
- auto_pci_link: true
auto_slot_id: true
auto_vnic_placement_enabled: false
cdn_source: vnic
connection_type: none
eth_adapter_policy_name: default-adapter-policy
eth_qos_policy_name: default-qos-policy
fabric_eth_network_control_policy_name: default-network-control
fabric_eth_network_group_policy_name: default-network-group
failover_enabled: false
mac_address_type: pool
mac_pool_name: default-mac-pool
name: pinned-vnic
order: 0
pin_group_name: pingroup-a
state: present
switch_id: A
name: Create a LAN Connectivity Policy with pin group for static pinning
- cisco.intersight.intersight_lan_connectivity_policy:
api_key_id: '{{ api_key_id }}'
api_private_key: '{{ api_private_key }}'
azure_qos_enabled: false
description: LAN connectivity policy with automatic vNIC placement
iqn_allocation_type: None
name: fi-attached-auto-placement-policy
organization: default
placement_mode: auto
state: present
target_platform: FIAttached
vnics:
- auto_vnic_placement_enabled: true
cdn_source: vnic
connection_type: none
eth_adapter_policy_name: default-adapter-policy
eth_qos_policy_name: default-qos-policy
fabric_eth_network_control_policy_name: default-network-control
fabric_eth_network_group_policy_name: default-network-group
failover_enabled: false
mac_address_type: pool
mac_pool_name: default-mac-pool
name: auto-placed-vnic
state: present
switch_id: A
name: Create a LAN Connectivity Policy with automatic vNIC placement
- cisco.intersight.intersight_lan_connectivity_policy:
api_key_id: '{{ api_key_id }}'
api_private_key: '{{ api_private_key }}'
azure_qos_enabled: false
description: LAN connectivity policy with advanced placement control
iqn_allocation_type: None
name: fi-attached-advanced-placement-policy
organization: default
placement_mode: custom
state: present
target_platform: FIAttached
vnics:
- auto_pci_link: false
auto_slot_id: false
auto_vnic_placement_enabled: false
cdn_source: vnic
connection_type: none
eth_adapter_policy_name: default-adapter-policy
eth_qos_policy_name: default-qos-policy
fabric_eth_network_control_policy_name: default-network-control
fabric_eth_network_group_policy_name: default-network-group
failover_enabled: false
mac_address_type: pool
mac_pool_name: default-mac-pool
name: advanced-placed-vnic
order: 9
pci_link: 0
pci_link_assignment_mode: Custom
placement_slot_id: "5"
state: present
switch_id: A
name: Create a LAN Connectivity Policy with advanced placement control
- cisco.intersight.intersight_lan_connectivity_policy:
api_key_id: '{{ api_key_id }}'
api_private_key: '{{ api_private_key }}'
azure_qos_enabled: false
description: LAN connectivity policy with load-balanced PCI assignment
iqn_allocation_type: None
name: fi-attached-load-balanced-policy
organization: default
placement_mode: custom
state: present
target_platform: FIAttached
vnics:
- auto_pci_link: false
auto_slot_id: false
auto_vnic_placement_enabled: false
cdn_source: vnic
connection_type: none
eth_adapter_policy_name: default-adapter-policy
eth_qos_policy_name: default-qos-policy
fabric_eth_network_control_policy_name: default-network-control
fabric_eth_network_group_policy_name: default-network-group
failover_enabled: true
mac_address_type: pool
mac_pool_name: default-mac-pool
name: load-balanced-vnic
order: 5
pci_link_assignment_mode: Load-Balanced
placement_slot_id: MLOM
state: present
switch_id: B
name: Create a LAN Connectivity Policy with load-balanced PCI assignment
- cisco.intersight.intersight_lan_connectivity_policy:
api_key_id: '{{ api_key_id }}'
api_private_key: '{{ api_private_key }}'
description: Policy with USNIC configuration
name: usnic-lan-policy
state: present
target_platform: Standalone
vnics:
- connection_type: usnic
eth_adapter_policy_name: hpc-adapter-policy
eth_network_policy_name: hpc-network-policy
eth_qos_policy_name: hpc-qos-policy
name: usnic-eth0
order: 0
pci_link: 0
placement_slot_id: "4"
uplink_port: 0
usnic_settings:
cos: 5
count: 0
usnic_adapter_policy_name: hpc-adapter-policy
name: Create a LAN Connectivity Policy with USNIC vNIC
- cisco.intersight.intersight_lan_connectivity_policy:
api_key_id: '{{ api_key_id }}'
api_private_key: '{{ api_private_key }}'
description: Policy with VMQ configuration
name: vmq-lan-policy
state: present
target_platform: Standalone
vnics:
- connection_type: vmq
eth_adapter_policy_name: vm-adapter-policy
eth_network_policy_name: vm-network-policy
eth_qos_policy_name: vm-qos-policy
name: vmq-eth0
order: 0
pci_link: 0
placement_slot_id: "10"
uplink_port: 2
vmq_settings:
enabled: true
multi_queue_support: false
num_interrupts: 16
num_vmqs: 4
name: Create a LAN Connectivity Policy with VMQ vNIC
- cisco.intersight.intersight_lan_connectivity_policy:
api_key_id: '{{ api_key_id }}'
api_private_key: '{{ api_private_key }}'
description: Policy with VMQ multi-queue configuration
name: vmq-multiqueue-lan-policy
state: present
target_platform: Standalone
vnics:
- connection_type: vmq
eth_adapter_policy_name: vm-adapter-policy
eth_network_policy_name: vm-network-policy
eth_qos_policy_name: vm-qos-policy
name: vmq-mq-eth0
order: 0
pci_link: 1
placement_slot_id: "11"
uplink_port: 3
vmq_settings:
enabled: true
multi_queue_support: true
num_sub_vnics: 64
vmmq_adapter_policy_name: vmmq-adapter-policy
name: Create a LAN Connectivity Policy with VMQ multi-queue support
- cisco.intersight.intersight_lan_connectivity_policy:
api_key_id: '{{ api_key_id }}'
api_private_key: '{{ api_private_key }}'
description: Policy with SR-IOV configuration
name: sriov-lan-policy
state: present
target_platform: Standalone
vnics:
- connection_type: sriov
eth_adapter_policy_name: sriov-adapter-policy
eth_network_policy_name: sriov-network-policy
eth_qos_policy_name: sriov-qos-policy
name: sriov-eth0
order: 0
pci_link: 0
placement_slot_id: "14"
sriov_settings:
comp_count_per_vf: 5
enabled: true
int_count_per_vf: 8
rx_count_per_vf: 4
tx_count_per_vf: 1
vf_count: 64
uplink_port: 1
name: Create a LAN Connectivity Policy with SR-IOV vNIC
- cisco.intersight.intersight_lan_connectivity_policy:
api_key_id: '{{ api_key_id }}'
api_private_key: '{{ api_private_key }}'
description: Policy with custom CDN values
name: custom-cdn-lan-policy
state: present
target_platform: Standalone
vnics:
- cdn_source: user
cdn_value: Management-NIC
connection_type: none
eth_adapter_policy_name: mgmt-adapter-policy
eth_network_policy_name: mgmt-network-policy
eth_qos_policy_name: mgmt-qos-policy
name: mgmt-nic
order: 0
pci_link: 0
placement_slot_id: "1"
uplink_port: 0
name: Create a LAN Connectivity Policy with custom CDN values
- cisco.intersight.intersight_lan_connectivity_policy:
api_key_id: '{{ api_key_id }}'
api_private_key: '{{ api_private_key }}'
description: Policy demonstrating vNIC state management
name: mixed-vnic-states-policy
organization: default
state: present
target_platform: Standalone
vnics:
- connection_type: none
eth_adapter_policy_name: standard-adapter
eth_network_policy_name: production-network
eth_qos_policy_name: standard-qos
name: eth0
order: 0
pci_link: 0
placement_slot_id: "1"
state: present
uplink_port: 0
- name: eth1-old
state: absent
- connection_type: vmq
eth_adapter_policy_name: standard-adapter
eth_network_policy_name: production-network
eth_qos_policy_name: standard-qos
name: eth2-new
order: 1
pci_link: 0
placement_slot_id: "3"
state: present
uplink_port: 1
vmq_settings:
enabled: true
multi_queue_support: false
num_interrupts: 16
num_vmqs: 4
name: Update LAN connectivity policy - manage vNIC states
- cisco.intersight.intersight_lan_connectivity_policy:
api_key_id: '{{ api_key_id }}'
api_private_key: '{{ api_private_key }}'
name: old-lan-policy
state: absent
name: Delete a LAN Connectivity Policy