cisco.ucs.ucs_ip_pool module – Configures IP address pools on Cisco UCS Manager
Note
This module is part of the cisco.ucs collection (version 1.8.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install cisco.ucs
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: cisco.ucs.ucs_ip_pool
.
New in cisco.ucs 2.5
Synopsis
Configures IP address pools and blocks of IP addresses on Cisco UCS Manager.
Requirements
The below requirements are needed on the host that executes this module.
ucsmsdk
Parameters
Parameter |
Comments |
---|---|
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). |
|
IP address or hostname of Cisco UCS Manager. Modules can be used with the UCS Platform Emulator https://cs.co/ucspe |
|
List of IPv4 blocks used by the IP Pool. |
|
The default gateway associated with the IPv4 addresses in the block. Default: |
|
The first IPv4 address in the IPv4 addresses block. This is the From field in the UCS Manager Add IPv4 Blocks menu. |
|
The last IPv4 address in the IPv4 addresses block. This is the To field in the UCS Manager Add IPv4 Blocks menu. |
|
The primary DNS server that this block of IPv4 addresses should access. Default: |
|
The secondary DNS server that this block of IPv4 addresses should access. Default: |
|
The subnet mask associated with the IPv4 addresses in the block. Default: |
|
List of IPv6 blocks used by the IP Pool. |
|
The default gateway associated with the IPv6 addresses in the block. Default: |
|
The first IPv6 address in the IPv6 addresses block. This is the From field in the UCS Manager Add IPv6 Blocks menu. |
|
The last IPv6 address in the IPv6 addresses block. This is the To field in the UCS Manager Add IPv6 Blocks menu. |
|
The network address prefix associated with the IPv6 addresses in the block. Default: |
|
The primary DNS server that this block of IPv6 addresses should access. Default: |
|
The secondary DNS server that this block of IPv6 addresses should access. Default: |
|
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. |
|
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. Choices:
|
|
Org dn (distinguished name) Default: |
|
Password for Cisco UCS Manager authentication. |
|
Port number to be used during connection (by default uses 443 for https and 80 for http connection). |
|
If use_proxy is no, specfies proxy to be used for connection. e.g. ‘http://proxy.xy.z:8080’ |
|
If If Choices:
|
|
If Choices:
|
|
If Choices:
|
|
Username for Cisco UCS Manager authentication. Default: |
Examples
- name: Configure IPv4 and IPv6 address pool
cisco.ucs.ucs_ip_pool:
hostname: "{{ ucs_hostname }}"
username: "{{ ucs_username }}"
password: "{{ ucs_password }}"
name: ip-pool-01
org_dn: org-root/org-level1
ipv4_blocks:
- first_addr: 192.168.10.1
last_addr: 192.168.10.20
subnet_mask: 255.255.255.128
default_gw: 192.168.10.2
- first_addr: 192.168.11.1
last_addr: 192.168.11.20
subnet_mask: 255.255.255.128
default_gw: 192.168.11.2
ipv6_blocks:
- ipv6_first_addr: fe80::1cae:7992:d7a1:ed07
ipv6_last_addr: fe80::1cae:7992:d7a1:edfe
ipv6_default_gw: fe80::1cae:7992:d7a1:ecff
- ipv6_first_addr: fe80::1cae:7992:d7a1:ec07
ipv6_last_addr: fe80::1cae:7992:d7a1:ecfe
ipv6_default_gw: fe80::1cae:7992:d7a1:ecff
- name: Delete IPv4 and IPv6 address pool blocks
cisco.ucs.ucs_ip_pool:
hostname: "{{ ucs_hostname }}"
username: "{{ ucs_username }}"
password: "{{ ucs_password }}"
name: ip-pool-01
org_dn: org-root/org-level1
ipv4_blocks:
- first_addr: 192.168.10.1
last_addr: 192.168.10.20
state: absent
ipv6_blocks:
- ipv6_first_addr: fe80::1cae:7992:d7a1:ec07
ipv6_last_addr: fe80::1cae:7992:d7a1:ecfe
state: absent
- name: Remove IPv4 and IPv6 address pool
cisco.ucs.ucs_ip_pool:
hostname: "{{ ucs_hostname }}"
username: "{{ ucs_username }}"
password: "{{ ucs_password }}"
name: ip-pool-01
state: absent