ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-04-26 12:21:26 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 6

i[b-n]*.py: normalize docs (#9393)

Browse source 
* i[b-n]*.py: normalize docs

* Update plugins/modules/ilo_redfish_command.py

Co-authored-by: Felix Fontein <felix@fontein.de>

---------

Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
Alexei Znamensky 2024-12-27 09:52:26 +13:00 • committed by GitHub
parent 61b2304f4d
commit 84655b0d0f
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
25 changed files with 1036 additions and 1100 deletions
Download patch file Download diff file Expand all files Collapse all files

73
plugins/modules/infinity.py
View file

@ -8,7 +8,7 @@
from __future__ import (absolute_import, division, print_function)
__metaclass__ = type
DOCUMENTATION = r'''
DOCUMENTATION = r"""
module: infinity
short_description: Manage Infinity IPAM using Rest API
description:
@ -41,10 +41,10 @@ options:
required: true
action:
description:
- Action to perform
- Action to perform.
type: str
required: true
choices: [add_network, delete_network, get_network, get_network_id, release_ip, release_network, reserve_network, reserve_next_available_ip ]
choices: [add_network, delete_network, get_network, get_network_id, release_ip, release_network, reserve_network, reserve_next_available_ip]
network_id:
description:
- Network ID.
@ -55,11 +55,11 @@ options:
type: str
network_address:
description:
- Network address with CIDR format (e.g., 192.168.310.0).
- Network address with CIDR format (for example V(192.168.310.0)).
type: str
network_size:
description:
- Network bitmask (e.g. 255.255.255.220) or CIDR format (e.g., /26).
- Network bitmask (for example V(255.255.255.220) or CIDR format V(/26)).
type: str
network_name:
description:
@ -72,20 +72,19 @@ options:
default: -1
network_type:
description:
- Network type defined by Infinity
- Network type defined by Infinity.
type: str
choices: [ lan, shared_lan, supernet ]
choices: [lan, shared_lan, supernet]
default: lan
network_family:
description:
- Network family defined by Infinity, e.g. IPv4, IPv6 and Dual stack
- Network family defined by Infinity, for example V(IPv4), V(IPv6) and V(Dual stack).
type: str
choices: [ '4', '6', dual ]
choices: ['4', '6', dual]
default: '4'
'''
"""
EXAMPLES = r'''
---
EXAMPLES = r"""
- hosts: localhost
connection: local
strategy: debug
@ -102,35 +101,35 @@ EXAMPLES = r'''
network_id: 1201
network_size: /28
register: infinity
'''
"""
RETURN = r'''
RETURN = r"""
network_id:
description: id for a given network
returned: success
type: str
sample: '1501'
description: Id for a given network.
returned: success
type: str
sample: '1501'
ip_info:
description: when reserve next available ip address from a network, the ip address info ) is returned.
returned: success
type: str
sample: '{"address": "192.168.10.3", "hostname": "", "FQDN": "", "domainname": "", "id": 3229}'
description: When reserve next available ip address from a network, the ip address info ) is returned.
returned: success
type: str
sample: '{"address": "192.168.10.3", "hostname": "", "FQDN": "", "domainname": "", "id": 3229}'
network_info:
description: when reserving a LAN network from a Infinity supernet by providing network_size, the information about the reserved network is returned.
returned: success
type: str
sample: {
"network_address": "192.168.10.32/28",
"network_family": "4",
"network_id": 3102,
"network_size": null,
"description": null,
"network_location": "3085",
"ranges": { "id": 0, "name": null,"first_ip": null,"type": null,"last_ip": null},
"network_type": "lan",
"network_name": "'reserve_new_ansible_network'"
}
'''
description: when reserving a LAN network from a Infinity supernet by providing network_size, the information about the reserved network is returned.
returned: success
type: str
sample: {
"network_address": "192.168.10.32/28",
"network_family": "4",
"network_id": 3102,
"network_size": null,
"description": null,
"network_location": "3085",
"ranges": { "id": 0, "name": null,"first_ip": null,"type": null,"last_ip": null},
"network_type": "lan",
"network_name": "'reserve_new_ansible_network'"
}
"""
from ansible.module_utils.basic import AnsibleModule, json