Documentation
  • Docs »
  • ucs_lan_connectivity – Configures LAN Connectivity Policies on Cisco UCS Manager

ucs_lan_connectivity – Configures LAN Connectivity Policies on Cisco UCS Manager

New in version 2.5.

Synopsis

Requirements

The below requirements are needed on the host that executes this module.

  • ucsmsdk

Parameters

Parameter Choices/Defaults Comments
description
-
A description of the LAN Connectivity Policy.
Cisco recommends including information about where and when to use the policy.
Enter up to 256 characters.
You can use any characters or spaces except the following:
` (accent mark), (backslash), ^ (carat), " (double quote), = (equal sign), > (greater than), < (less than), or ' (single quote).

aliases: descr
hostname
string / required
IP address or hostname of Cisco UCS Manager.
iscsi_vnic_list
-
added in 2.8
List of iSCSI vNICs used by the LAN Connectivity Policy.
iscsi_adapter_policy
-
The iSCSI adapter policy associated with this iSCSI vNIC.
mac_address
-
Default:
"derived"
The MAC address associated with this iSCSI vNIC.
If the MAC address is not set, Cisco UCS Manager uses a derived MAC address.
name
- / required
The name of the iSCSI vNIC.
overlay_vnic
-
The LAN vNIC associated with this iSCSI vNIC.
state
-
    Choices:
  • present ←
  • absent
If present, will verify iscsi vnic is configured within policy. If absent, will verify iscsi vnic is absent from policy.
vlan_name
-
Default:
"default"
The VLAN used for the iSCSI vNIC.
name
- / required
The name of the LAN Connectivity Policy.
This name can be between 1 and 16 alphanumeric characters.
You cannot use spaces or any special characters other than - (hyphen), "_" (underscore), : (colon), and . (period).
You cannot change this name after the policy is created.
org_dn
-
Default:
"org-root"
Org dn (distinguished name)
password
string / required
Password for Cisco UCS Manager authentication.
port
integer
Port number to be used during connection (by default uses 443 for https and 80 for http connection).
proxy
string
If use_proxy is no, specfies proxy to be used for connection. e.g. 'http://proxy.xy.z:8080'
state
-
    Choices:
  • present ←
  • absent
If present, will verify LAN Connectivity Policies are present and will create if needed.
If absent, will verify LAN Connectivity Policies are absent and will delete if needed.
use_proxy
boolean
    Choices:
  • no
  • yes ←
If no, will not use the proxy as defined by system environment variable.
use_ssl
boolean
    Choices:
  • no
  • yes ←
If no, an HTTP connection will be used instead of the default HTTPS connection.
username
string
Default:
"admin"
Username for Cisco UCS Manager authentication.
vnic_list
-
added in 2.8
List of vNICs used by the LAN Connectivity Policy.
vNICs used by the LAN Connectivity Policy must be created from a vNIC template.
adapter_policy
-
The name of the Ethernet adapter policy.
A user defined policy can be used, or one of the system defined policies.
name
- / required
The name of the vNIC.
order
-
Default:
"unspecified"
String specifying the vNIC assignment order (e.g., '1', '2').
state
-
    Choices:
  • present ←
  • absent
If present, will verify vnic is configured within policy. If absent, will verify vnic is absent from policy.
vnic_template
- / required
The name of the vNIC template.

Examples

- name: Configure LAN Connectivity Policy
  ucs_lan_connectivity:
    hostname: 172.16.143.150
    username: admin
    password: password
    name: Cntr-FC-Boot
    vnic_list:
    - name: eno1
      vnic_template: Cntr-Template
      adapter_policy: Linux
    - name: eno2
      vnic_template: Container-NFS-A
      adapter_policy: Linux
    - name: eno3
      vnic_template: Container-NFS-B
      adapter_policy: Linux
    iscsi_vnic_list:
    - name: iSCSIa
      overlay_vnic: eno1
      iscsi_adapter_policy: default
      vlan_name: Container-MGMT-VLAN
    - name: iSCSIb
      overlay_vnic: eno3
      iscsi_adapter_policy: default
      vlan_name: Container-TNT-A-NFS

- name: Remove LAN Connectivity Policy
  ucs_lan_connectivity:
    hostname: 172.16.143.150
    username: admin
    password: password
    name: Cntr-FC-Boot
    state: absent

Status

Authors

  • David Soper (@dsoper2)
  • CiscoUcs (@CiscoUcs)

Hint

If you notice any issues in this documentation you can edit this document to improve it.