Documentation

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
required
IP address or hostname of Cisco UCS Manager.
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
required
Password for Cisco UCS Manager authentication.
port
Port number to be used during connection (by default uses 443 for https and 80 for http connection).
proxy
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
    Choices:
  • no
  • yes ←
If no, will not use the proxy as defined by system environment variable.
use_ssl
    Choices:
  • no
  • yes ←
If no, an HTTP connection will be used instead of the default HTTPS connection.
username
Default:
admin
Username for Cisco UCS Manager authentication.
vnic_list
List of vNICs used by the LAN Connectivity Policy.
vNICs used by the LAN Connectivity Policy must be created from a vNIC template.
Each list element has the following suboptions:
= name
The name of the vNIC (required).
= vnic_template
The name of the vNIC template (required).
- adapter_policy
The name of the Ethernet adapter policy.
A user defined policy can be used, or one of the system defined policies.
- order
String specifying the vNIC assignment order (e.g., '1', '2').
[Default: unspecified]

Examples

- name: Configure LAN Connectivity Policy
  ucs_lan_connectivity:
    hostname: 172.16.143.150
    username: admin
    password: password
    name: Cntr-LAN-Boot
    vnic_list:
    - name: Fabric-A
      vnic_template: vNIC-Template-A
      adapter_policy: Linux
    - name: Fabric-B
      vnic_template: vNIC-Template-B
      adapter_policy: Linux

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

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Author

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

Hint

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