cisco.ucs.ucs_ip_pool – Configures IP address pools on Cisco UCS Manager
cisco.ucs.ucs_ip_pool – Configures IP address pools on Cisco UCS Manager
Note
This plugin is part of the cisco.ucs collection (version 1.6.0).
To install it use: ansible-galaxy collection install cisco.ucs
.
To use it in a playbook, specify: cisco.ucs.ucs_ip_pool
.
New in version 2.5: of cisco.ucs
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 | Choices/Defaults | Comments | |
---|---|---|---|
description string |
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).
| ||
hostname string / required |
IP address or hostname of Cisco UCS Manager. Modules can be used with the UCS Platform Emulator https://cs.co/ucspe | ||
ip_blocks string |
List of IPv4 blocks used by the IP Pool. | ||
default_gw string |
Default: "0.0.0.0" |
The default gateway associated with the IPv4 addresses in the block. | |
first_addr string |
The first IPv4 address in the IPv4 addresses block. This is the From field in the UCS Manager Add IPv4 Blocks menu. | ||
last_addr string |
The last IPv4 address in the IPv4 addresses block. This is the To field in the UCS Manager Add IPv4 Blocks menu. | ||
primary_dns string |
Default: "0.0.0.0" |
The primary DNS server that this block of IPv4 addresses should access. | |
secondary_dns string |
Default: "0.0.0.0" |
The secondary DNS server that this block of IPv4 addresses should access. | |
subnet_mask string |
Default: "255.255.255.0" |
The subnet mask associated with the IPv4 addresses in the block. | |
ipv6_blocks string |
List of IPv6 blocks used by the IP Pool. | ||
ipv6_default_gw string |
Default: "::" |
The default gateway associated with the IPv6 addresses in the block. | |
ipv6_first_addr string |
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 string |
The last IPv6 address in the IPv6 addresses block. This is the To field in the UCS Manager Add IPv6 Blocks menu. | ||
ipv6_prefix string |
Default: "64" |
The network address prefix associated with the IPv6 addresses in the block. | |
ipv6_primary_dns string |
Default: "::" |
The primary DNS server that this block of IPv6 addresses should access. | |
ipv6_secondary_dns string |
Default: "::" |
The secondary DNS server that this block of IPv6 addresses should access. | |
name string / 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 string |
|
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 string |
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 string |
|
If If | |
use_proxy boolean |
|
If | |
use_ssl boolean |
|
If | |
username string |
Default: "admin" |
Username for Cisco UCS Manager authentication. |
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
Authors
- Brett Johnson (@sdbrett)
- David Soper (@dsoper2)
- John McDonough (@movinalot)
- CiscoUcs (@CiscoUcs)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/cisco/ucs/ucs_ip_pool_module.html