archive
/
ansible
mirror of https://github.com/ansible/ansible.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

fixed doc issues

Browse Source
pull/18777/head
Brian Coca 10 years ago committed by Matt Clay
parent dab27eb089
commit 50bf780709
1 changed files with 36 additions and 35 deletions
Show Stats Download Patch File Download Diff File

69
lib/ansible/modules/extras/network/nmcli.py
Unescape Escape View File

@ -25,6 +25,7 @@ module: nmcli
author: Chris Long author: Chris Long
short_description: Manage Networking short_description: Manage Networking
requirements: [ nmcli, dbus ] requirements: [ nmcli, dbus ]
version_added: "2.0"
description: description:
- Manage the network devices. Create, modify, and manage, ethernet, teams, bonds, vlans etc. - Manage the network devices. Create, modify, and manage, ethernet, teams, bonds, vlans etc.
options: options:
@ -39,11 +40,11 @@ options:
choices: [ "yes", "no" ] choices: [ "yes", "no" ]
description: description:
- Whether the connection should start on boot. - Whether the connection should start on boot.
- Whether the connection profile can be automatically activated ( default: yes) - Whether the connection profile can be automatically activated
conn_name: conn_name:
required: True required: True
description: description:
- Where conn_name will be the name used to call the connection. when not provided a default name is generated: <type>[-<ifname>][-<num>] - 'Where conn_name will be the name used to call the connection. when not provided a default name is generated: <type>[-<ifname>][-<num>]'
ifname: ifname:
required: False required: False
default: conn_name default: conn_name
@ -60,9 +61,9 @@ options:
mode: mode:
required: False required: False
choices: [ "balance-rr", "active-backup", "balance-xor", "broadcast", "802.3ad", "balance-tlb", "balance-alb" ] choices: [ "balance-rr", "active-backup", "balance-xor", "broadcast", "802.3ad", "balance-tlb", "balance-alb" ]
default: None default: balence-rr
description: description:
- This is the type of device or network connection that you wish to create for a bond, team or bridge. (NetworkManager default: balance-rr) - This is the type of device or network connection that you wish to create for a bond, team or bridge.
master: master:
required: False required: False
default: None default: None
@ -72,35 +73,35 @@ options:
required: False required: False
default: None default: None
description: description:
- The IPv4 address to this interface using this format ie: "192.168.1.24/24" - 'The IPv4 address to this interface using this format ie: "192.168.1.24/24"'
gw4: gw4:
required: False required: False
description: description:
- The IPv4 gateway for this interface using this format ie: "192.168.100.1" - 'The IPv4 gateway for this interface using this format ie: "192.168.100.1"'
dns4: dns4:
required: False required: False
default: None default: None
description: description:
- A list of upto 3 dns servers, ipv4 format e.g. To add two IPv4 DNS server addresses: ['"8.8.8.8 8.8.4.4"'] - 'A list of upto 3 dns servers, ipv4 format e.g. To add two IPv4 DNS server addresses: ["8.8.8.8 8.8.4.4"]'
ip6: ip6:
required: False required: False
default: None default: None
description: description:
- The IPv6 address to this interface using this format ie: "abbe::cafe" - 'The IPv6 address to this interface using this format ie: "abbe::cafe"'
gw6: gw6:
required: False required: False
default: None default: None
description: description:
- The IPv6 gateway for this interface using this format ie: "2001:db8::1" - 'The IPv6 gateway for this interface using this format ie: "2001:db8::1"'
dns6: dns6:
required: False required: False
description: description:
- A list of upto 3 dns servers, ipv6 format e.g. To add two IPv6 DNS server addresses: ['"2001:4860:4860::8888 2001:4860:4860::8844"'] - 'A list of upto 3 dns servers, ipv6 format e.g. To add two IPv6 DNS server addresses: ["2001:4860:4860::8888 2001:4860:4860::8844"]'
mtu: mtu:
required: False required: False
default: None default: 1500
description: description:
- The connection MTU, e.g. 9000. This can't be applied when creating the interface and is done once the interface has been created. (NetworkManager default: 1500) - The connection MTU, e.g. 9000. This can't be applied when creating the interface and is done once the interface has been created.
- Can be used when modifying Team, VLAN, Ethernet (Future plans to implement wifi, pppoe, infiniband) - Can be used when modifying Team, VLAN, Ethernet (Future plans to implement wifi, pppoe, infiniband)
primary: primary:
required: False required: False
@ -109,24 +110,24 @@ options:
- This is only used with bond and is the primary interface name (for "active-backup" mode), this is the usually the 'ifname' - This is only used with bond and is the primary interface name (for "active-backup" mode), this is the usually the 'ifname'
miimon: miimon:
required: False required: False
default: None default: 100
description: description:
- This is only used with bond - miimon (NetworkManager default: 100) - This is only used with bond - miimon
downdelay: downdelay:
required: False required: False
default: None default: None
description: description:
- This is only used with bond - downdelay (NetworkManager default: 0) - This is only used with bond - downdelay
updelay: updelay:
required: False required: False
default: None default: None
description: description:
- This is only used with bond - updelay (NetworkManager default: 0) - This is only used with bond - updelay
arp_interval: arp_interval:
required: False required: False
default: None default: None
description: description:
- This is only used with bond - ARP interval (NetworkManager default: 0) - This is only used with bond - ARP interval
arp_ip_target: arp_ip_target:
required: False required: False
default: None default: None
@ -139,49 +140,49 @@ options:
- This is only used with bridge and controls whether Spanning Tree Protocol (STP) is enabled for this bridge - This is only used with bridge and controls whether Spanning Tree Protocol (STP) is enabled for this bridge
priority: priority:
required: False required: False
default: None default: 128
description: description:
- This is only used with 'bridge' - sets STP priority (NetworkManager default: 128) - This is only used with 'bridge' - sets STP priority
forwarddelay: forwarddelay:
required: False required: False
default: None default: 15
description: description:
- This is only used with bridge - [forward-delay <2-30>] STP forwarding delay, in seconds (NetworkManager default: 15) - This is only used with bridge - [forward-delay <2-30>] STP forwarding delay, in seconds
hellotime: hellotime:
required: False required: False
default: None default: 2
description: description:
- This is only used with bridge - [hello-time <1-10>] STP hello time, in seconds (NetworkManager default: 2) - This is only used with bridge - [hello-time <1-10>] STP hello time, in seconds
maxage: maxage:
required: False required: False
default: None default: 20
description: description:
- This is only used with bridge - [max-age <6-42>] STP maximum message age, in seconds (NetworkManager default: 20) - This is only used with bridge - [max-age <6-42>] STP maximum message age, in seconds
ageingtime: ageingtime:
required: False required: False
default: None default: 300
description: description:
- This is only used with bridge - [ageing-time <0-1000000>] the Ethernet MAC address aging time, in seconds (NetworkManager default: 300) - This is only used with bridge - [ageing-time <0-1000000>] the Ethernet MAC address aging time, in seconds
mac: mac:
required: False required: False
default: None default: None
description: description:
- This is only used with bridge - MAC address of the bridge (note: this requires a recent kernel feature, originally introduced in 3.15 upstream kernel) - 'This is only used with bridge - MAC address of the bridge (note: this requires a recent kernel feature, originally introduced in 3.15 upstream kernel)'
slavepriority: slavepriority:
required: False required: False
default: None default: 32
description: description:
- This is only used with 'bridge-slave' - [<0-63>] - STP priority of this slave (default: 32) - This is only used with 'bridge-slave' - [<0-63>] - STP priority of this slave
path_cost: path_cost:
required: False required: False
default: None default: 100
description: description:
- This is only used with 'bridge-slave' - [<1-65535>] - STP port cost for destinations via this slave (NetworkManager default: 100) - This is only used with 'bridge-slave' - [<1-65535>] - STP port cost for destinations via this slave
hairpin: hairpin:
required: False required: False
default: None default: yes
description: description:
- This is only used with 'bridge-slave' - 'hairpin mode' for the slave, which allows frames to be sent back out through the slave the frame was received on. (NetworkManager default: yes) - This is only used with 'bridge-slave' - 'hairpin mode' for the slave, which allows frames to be sent back out through the slave the frame was received on.
vlanid: vlanid:
required: False required: False
default: None default: None

Write Preview
Loading…
Cancel
Save