ansible.builtin.ucs_wwn_pool (v2.9.0) — module

Configures WWNN or WWPN pools on Cisco UCS Manager

| "added in version" 2.5 of ansible.builtin"

Authors: David Soper (@dsoper2), CiscoUcs (@CiscoUcs)

preview | supported by certified

Install Ansible via pip

Install with pip install ansible==2.9.0

Description

Configures WWNNs or WWPN pools on Cisco UCS Manager.

Examples can be used with the UCS Platform Emulator U(https://communities.cisco.com/ucspe).


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Configure WWNN/WWPN pools
  ucs_wwn_pool:
    hostname: 172.16.143.150
    username: admin
    password: password
    name: WWNN-Pool
    purpose: node
    first_addr: 20:00:00:25:B5:48:00:00
    last_addr: 20:00:00:25:B5:48:00:0F
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- ucs_wwn_pool:
    hostname: 172.16.143.150
    username: admin
    password: password
    name: WWPN-Pool-A
    purpose: port
    order: sequential
    first_addr: 20:00:00:25:B5:48:0A:00
    last_addr: 20:00:00:25:B5:48:0A:0F
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Remove WWNN/WWPN pools
  ucs_wwn_pool:
    hostname: 172.16.143.150
    username: admin
    password: password
    name: WWNN-Pool
    state: absent
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- ucs_wwn_pool:
    hostname: 172.16.143.150
    username: admin
    password: password
    name: WWPN-Pool-A
    state: absent

Inputs

    
name:
    description:
    - The name of the World Wide Node Name (WWNN) or World Wide Port Name (WWPN) pool.
    - This name can be between 1 and 32 alphanumeric characters.
    - 'You cannot use spaces or any special characters other than - (hyphen), "_" (underscore),
      : (colon), and . (period).'
    - You cannot change this name after the WWNN or WWPN pool is created.
    required: true

port:
    description:
    - Port number to be used during connection (by default uses 443 for https and 80 for
      http connection).
    type: int

order:
    choices:
    - default
    - sequential
    default: default
    description:
    - The Assignment Order field.
    - 'This can be one of the following:'
    - default - Cisco UCS Manager selects a random identity from the pool.
    - sequential - Cisco UCS Manager selects the lowest available identity from the pool.

proxy:
    description:
    - If use_proxy is no, specfies proxy to be used for connection. e.g. 'http://proxy.xy.z:8080'
    type: str

state:
    choices:
    - present
    - absent
    default: present
    description:
    - If C(present), will verify WWNNs/WWPNs are present and will create if needed.
    - If C(absent), will verify WWNNs/WWPNs are absent and will delete if needed.

org_dn:
    default: org-root
    description:
    - Org dn (distinguished name)

purpose:
    choices:
    - node
    - port
    description:
    - Specify whether this is a node (WWNN) or port (WWPN) pool.
    - Optional if state is absent.
    required: true

use_ssl:
    default: true
    description:
    - If C(no), an HTTP connection will be used instead of the default HTTPS connection.
    type: bool

hostname:
    description:
    - IP address or hostname of Cisco UCS Manager.
    - Modules can be used with the UCS Platform Emulator U(https://cs.co/ucspe)
    required: true
    type: str

password:
    description:
    - Password for Cisco UCS Manager authentication.
    required: true
    type: str

username:
    default: admin
    description:
    - Username for Cisco UCS Manager authentication.
    type: str

last_addr:
    description:
    - The last initiator in the World Wide Name (WWN) block.
    - This is the To field in the UCS Manager Add WWN Blocks menu.
    - For WWxN pools, the pool size must be a multiple of ports-per-node + 1.
    - For example, if there are 7 ports per node, the pool size must be a multiple of
      8.
    - If there are 63 ports per node, the pool size must be a multiple of 64.

use_proxy:
    default: true
    description:
    - If C(no), will not use the proxy as defined by system environment variable.
    type: bool

first_addr:
    description:
    - The first initiator in the World Wide Name (WWN) block.
    - This is the From field in the UCS Manager Add WWN Blocks menu.

description:
    aliases:
    - descr
    description:
    - A description of the WWNN or WWPN pool.
    - 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).'