rseries_management_interfaces – Manage DHCP, IPv4 and IPv6 on F5OS rSeries devices¶
New in version 1.16.0.
Synopsis¶
- Manage DHCP, IPv4, IPv6
- IPv4 contains IP Address, Prefix length, Gateway
- IPv6 contains IP Address, Prefix length, Gateway
Parameters¶
| Parameter | Choices/Defaults | Configuration | Comments | |
|---|---|---|---|---|
|
dhcp
boolean
/ required
|
|
This specifies Configuration of DHCP. DHCP is supported only on static interfaces
|
||
|
ipv4
dictionary
|
T
h
i
s
s
p
e
c
i
f
i
e
s
C
o
n
f
i
g
u
r
a
t
i
o
n
o
f
I
P
v
4
|
|||
|
gateway
string
|
Default: "0.0.0.0"
|
S
p
e
c
i
f
i
e
s
t
h
e
G
a
t
e
w
a
y
f
o
r
I
P
v
4
.
T
h
e
d
e
f
a
u
l
t
g
a
t
e
w
a
y
f
o
r
t
h
e
s
u
b
n
e
t
(
l
e
a
f
)
.
|
||
|
ip_address
string
|
Default: "0.0.0.0"
|
S
p
e
c
i
f
i
e
s
t
h
e
I
P
A
d
d
r
e
s
s
.
|
||
|
prefix_length
integer
|
Default: 0
|
S
p
e
c
i
f
i
e
s
t
h
e
P
r
e
f
i
x
l
e
n
g
t
h
o
f
I
P
v
4
.
T
h
e
l
e
n
g
t
h
o
f
t
h
e
s
u
b
n
e
t
p
r
e
f
i
x
(
l
e
a
f
)
.
|
||
|
ipv6
dictionary
|
T
h
i
s
s
p
e
c
i
f
i
e
s
C
o
n
f
i
g
u
r
a
t
i
o
n
o
f
I
P
v
6
|
|||
|
gateway
string
|
Default: "::"
|
S
p
e
c
i
f
i
e
s
t
h
e
G
a
t
e
w
a
y
f
o
r
I
P
v
6
.
T
h
e
d
e
f
a
u
l
t
g
a
t
e
w
a
y
f
o
r
t
h
e
s
u
b
n
e
t
(
l
e
a
f
)
.
|
||
|
ip_address
string
|
Default: "::"
|
S
p
e
c
i
f
i
e
s
t
h
e
I
P
A
d
d
r
e
s
s
.
|
||
|
prefix_length
integer
|
Default: 0
|
S
p
e
c
i
f
i
e
s
t
h
e
P
r
e
f
i
x
l
e
n
g
t
h
o
f
I
P
v
6
.
T
h
e
l
e
n
g
t
h
o
f
t
h
e
s
u
b
n
e
t
p
r
e
f
i
x
(
l
e
a
f
)
.
|
||
|
state
string
|
|
If
present, Configurations are posted on F5OS. |
||
Examples¶
- name: Manage DHCP, IPv4 and IPv6 on F5OS devices
rseries_management_interfaces:
dhcp: true
ipv4:
ip_address: 10.1.1.2
prefix_length: 24
gateway: 10.1.1.1
ipv6:
ip_address: 2001:db8:1::2
prefix_length: 64
gateway: 2001:db8:1::1
state: present
Return Values¶
The following are the fields unique to this module:
| Key | Returned | Description | |
|---|---|---|---|
|
dhcp
boolean
|
changed |
This specifies Configuration of DHCP. DHCP is supported only on static interfaces (leaf)
|
|
|
ipv4
complex
|
changed |
This specifies Configuration of IPv4
|
|
|
gateway
string
|
changed |
Specifies the Gateway for IPv4. The default gateway for the subnet (leaf).
|
|
|
ip_address
string
|
changed |
Specifies the IP Address.
|
|
|
prefix_length
integer
|
changed |
Specifies the Prefix length of IPv4. The length of the subnet prefix (leaf).
|
|
|
ipv6
complex
|
changed |
This specifies Configuration of IPv6
|
|
|
gateway
string
|
changed |
Specifies the Gateway for IPv6. The default gateway for the subnet (leaf).
|
|
|
ip_address
string
|
changed |
Specifies the IP Address.
|
|
|
prefix_length
integer
|
changed |
Specifies the Prefix length of IPv6. The length of the subnet prefix (leaf).
|
|