mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-24 03:11:24 -07:00
[PR #9372/bef82e28 backport][stable-10] p[a-e]*: normalize docs (#9397)
p[a-e]*: normalize docs (#9372)
* p[a-e]*: normalize docs
* Update plugins/modules/packet_volume.py
Co-authored-by: Felix Fontein <felix@fontein.de>
---------
Co-authored-by: Felix Fontein <felix@fontein.de>
(cherry picked from commit bef82e28a2
)
Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
This commit is contained in:
parent
641b0693b4
commit
872bc91096
17 changed files with 867 additions and 945 deletions
|
@ -10,26 +10,24 @@ from __future__ import absolute_import, division, print_function
|
|||
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
DOCUMENTATION = r"""
|
||||
module: packet_ip_subnet
|
||||
|
||||
short_description: Assign IP subnet to a bare metal server
|
||||
|
||||
description:
|
||||
- Assign or unassign IPv4 or IPv6 subnets to or from a device in the Packet host.
|
||||
- IPv4 subnets must come from already reserved block.
|
||||
- IPv6 subnets must come from publicly routable /56 block from your project.
|
||||
- See U(https://support.packet.com/kb/articles/elastic-ips) for more info on IP block reservation.
|
||||
|
||||
- Assign or unassign IPv4 or IPv6 subnets to or from a device in the Packet host.
|
||||
- IPv4 subnets must come from already reserved block.
|
||||
- IPv6 subnets must come from publicly routable /56 block from your project.
|
||||
- See U(https://support.packet.com/kb/articles/elastic-ips) for more info on IP block reservation.
|
||||
version_added: '0.2.0'
|
||||
|
||||
author:
|
||||
- Tomas Karasek (@t0mk) <tom.to.the.k@gmail.com>
|
||||
- Nurfet Becirevic (@nurfet-becirevic) <nurfet.becirevic@gmail.com>
|
||||
- Tomas Karasek (@t0mk) <tom.to.the.k@gmail.com>
|
||||
- Nurfet Becirevic (@nurfet-becirevic) <nurfet.becirevic@gmail.com>
|
||||
|
||||
extends_documentation_fragment:
|
||||
- community.general.attributes
|
||||
- community.general.attributes
|
||||
|
||||
attributes:
|
||||
check_mode:
|
||||
|
@ -77,7 +75,8 @@ options:
|
|||
state:
|
||||
description:
|
||||
- Desired state of the IP subnet on the specified device.
|
||||
- With O(state=present), you must specify either O(hostname) or O(device_id). Subnet with given CIDR will then be assigned to the specified device.
|
||||
- With O(state=present), you must specify either O(hostname) or O(device_id). Subnet with given CIDR will then be assigned to the specified
|
||||
device.
|
||||
- With O(state=absent), you can specify either O(hostname) or O(device_id). The subnet will be removed from specified devices.
|
||||
- If you leave both O(hostname) and O(device_id) empty, the subnet will be removed from any device it's assigned to.
|
||||
choices: ['present', 'absent']
|
||||
|
@ -85,10 +84,10 @@ options:
|
|||
type: str
|
||||
|
||||
requirements:
|
||||
- "packet-python >= 1.35"
|
||||
'''
|
||||
- "packet-python >= 1.35"
|
||||
"""
|
||||
|
||||
EXAMPLES = '''
|
||||
EXAMPLES = r"""
|
||||
# All the examples assume that you have your Packet API token in env var PACKET_API_TOKEN.
|
||||
# You can also pass it to the auth_token parameter of the module instead.
|
||||
|
||||
|
@ -96,33 +95,33 @@ EXAMPLES = '''
|
|||
hosts: localhost
|
||||
tasks:
|
||||
|
||||
- packet_device:
|
||||
project_id: 89b497ee-5afc-420a-8fb5-56984898f4df
|
||||
hostnames: myserver
|
||||
operating_system: ubuntu_16_04
|
||||
plan: baremetal_0
|
||||
facility: sjc1
|
||||
state: active
|
||||
- packet_device:
|
||||
project_id: 89b497ee-5afc-420a-8fb5-56984898f4df
|
||||
hostnames: myserver
|
||||
operating_system: ubuntu_16_04
|
||||
plan: baremetal_0
|
||||
facility: sjc1
|
||||
state: active
|
||||
|
||||
# Pick an IPv4 address from a block allocated to your project.
|
||||
|
||||
- community.general.packet_ip_subnet:
|
||||
project_id: 89b497ee-5afc-420a-8fb5-56984898f4df
|
||||
hostname: myserver
|
||||
cidr: "147.75.201.78/32"
|
||||
- community.general.packet_ip_subnet:
|
||||
project_id: 89b497ee-5afc-420a-8fb5-56984898f4df
|
||||
hostname: myserver
|
||||
cidr: "147.75.201.78/32"
|
||||
|
||||
# Release IP address 147.75.201.78
|
||||
|
||||
- name: Unassign IP address from any device in your project
|
||||
hosts: localhost
|
||||
tasks:
|
||||
- community.general.packet_ip_subnet:
|
||||
project_id: 89b497ee-5afc-420a-8fb5-56984898f4df
|
||||
cidr: "147.75.201.78/32"
|
||||
state: absent
|
||||
'''
|
||||
- community.general.packet_ip_subnet:
|
||||
project_id: 89b497ee-5afc-420a-8fb5-56984898f4df
|
||||
cidr: "147.75.201.78/32"
|
||||
state: absent
|
||||
"""
|
||||
|
||||
RETURN = '''
|
||||
RETURN = r"""
|
||||
changed:
|
||||
description: True if an IP address assignments were altered in any way (created or removed).
|
||||
type: bool
|
||||
|
@ -140,7 +139,7 @@ subnet:
|
|||
sample:
|
||||
address: 147.75.90.241
|
||||
address_family: 4
|
||||
assigned_to: { href : /devices/61f9aa5e-0530-47f5-97c2-113828e61ed0 }
|
||||
assigned_to: {href: /devices/61f9aa5e-0530-47f5-97c2-113828e61ed0}
|
||||
cidr: 31
|
||||
created_at: '2017-08-07T15:15:30Z'
|
||||
enabled: true
|
||||
|
@ -153,7 +152,7 @@ subnet:
|
|||
network: 147.75.90.240
|
||||
public: true
|
||||
returned: success
|
||||
'''
|
||||
"""
|
||||
|
||||
|
||||
import uuid
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue