ucs_ip_pool – Configures IP address pools on Cisco UCS Manager — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# ucs_ip_pool – Configures IP address pools on Cisco UCS Manager

New in version 2.5.

- Synopsis

- Requirements

- Parameters

- Examples

- Status

## Synopsis

- Configures IP address pools and blocks of IP addresses on Cisco UCS Manager.

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

## Requirements

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

- ucsmsdk

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
default_gw - | Default: "0.0.0.0" | The default gateway associated with the IPv4 addresses in the block.
description - |  | The user-defined description of the IP address 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). aliases: descr, descrption
first_addr - |  | The first IPv4 address in the IPv4 addresses block. This is the From field in the UCS Manager Add IPv4 Blocks menu.
hostname string / required |  | IP address or hostname of Cisco UCS Manager.
ipv6_default_gw - | Default: "::" | The default gateway associated with the IPv6 addresses in the block.
ipv6_first_addr - |  | The first IPv6 address in the IPv6 addresses block. This is the From field in the UCS Manager Add IPv6 Blocks menu.
ipv6_last_addr - |  | The last IPv6 address in the IPv6 addresses block. This is the To field in the UCS Manager Add IPv6 Blocks menu.
ipv6_prefix - | Default: "64" | The network address prefix associated with the IPv6 addresses in the block.
ipv6_primary_dns - | Default: "::" | The primary DNS server that this block of IPv6 addresses should access.
ipv6_secondary_dns - | Default: "::" | The secondary DNS server that this block of IPv6 addresses should access.
last_addr - |  | The last IPv4 address in the IPv4 addresses block. This is the To field in the UCS Manager Add IPv4 Blocks menu.
name - / required |  | The name of the IP address 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 IP address pool is created.
order - | Choices: default ← sequential | 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.
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).
primary_dns - | Default: "0.0.0.0" | The primary DNS server that this block of IPv4 addresses should access.
proxy string |  | If use_proxy is no, specfies proxy to be used for connection. e.g. 'http://proxy.xy.z:8080'
secondary_dns - | Default: "0.0.0.0" | The secondary DNS server that this block of IPv4 addresses should access.
state - | Choices: present ← absent | If `present`, will verify IP pool is present and will create if needed. If `absent`, will verify IP pool is absent and will delete if needed.
subnet_mask - | Default: "255.255.255.0" | The subnet mask associated with the IPv4 addresses in the block.
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.

## Examples

    - name: Configure IPv4 address pools
      ucs_ip_pool:
        hostname: 172.16.143.150
        username: admin
        password: password
        name: ip-A
        order: sequential
        first_addr: 192.168.0.10
        last_addr: 192.168.0.19
        subnet_mask: 255.255.255.0
        default_gw: 192.168.0.1
        primary_dns: 172.16.143.136
    - name: Configure IPv6 address pools
      ucs_ip_pool:
        hostname: 172.16.143.150
        username: admin
        password: password
        name: ipv6-B
        ipv6_first_addr: fe80::1cae:7992:d7a1:ed07
        ipv6_last_addr: fe80::1cae:7992:d7a1:edfe
        ipv6_default_gw: fe80::1cae:7992:d7a1:ecff

    - name: Remove IPv4 address pools
      ucs_ip_pool:
        hostname: 172.16.143.150
        username: admin
        password: password
        name: ip-A
        state: absent
    - name: Remove IPv6 address pools
      ucs_ip_pool:
        hostname: 172.16.143.150
        username: admin
        password: password
        name: ipv6-B
        state: absent

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]

- This module is maintained by an Ansible Partner. [certified]

### Authors

- David Soper (@dsoper2)

- CiscoUcs (@CiscoUcs)

Hint

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