mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-08-03 04:34:24 -07:00
doc style adjustments: modules x*
This commit is contained in:
parent
4444b148f0
commit
2ef9930ce7
4 changed files with 168 additions and 158 deletions
|
@ -273,33 +273,34 @@ redfish_facts:
|
|||
description: Resource content.
|
||||
returned: when command == GetResource or command == GetCollectionResource
|
||||
type: dict
|
||||
sample: '{
|
||||
"redfish_facts": {
|
||||
"data": {
|
||||
"@odata.etag": "\"3179bf00d69f25a8b3c\"",
|
||||
"@odata.id": "/redfish/v1/Managers/1/NetworkProtocol/Oem/Lenovo/DNS",
|
||||
"@odata.type": "#LenovoDNS.v1_0_0.LenovoDNS",
|
||||
"DDNS": [
|
||||
{
|
||||
"DDNSEnable": true,
|
||||
"DomainName": "",
|
||||
"DomainNameSource": "DHCP"
|
||||
}
|
||||
],
|
||||
"DNSEnable": true,
|
||||
"Description": "This resource is used to represent a DNS resource for a Redfish implementation.",
|
||||
"IPv4Address1": "10.103.62.178",
|
||||
"IPv4Address2": "0.0.0.0",
|
||||
"IPv4Address3": "0.0.0.0",
|
||||
"IPv6Address1": "::",
|
||||
"IPv6Address2": "::",
|
||||
"IPv6Address3": "::",
|
||||
"Id": "LenovoDNS",
|
||||
"PreferredAddresstype": "IPv4"
|
||||
},
|
||||
"ret": true
|
||||
sample:
|
||||
{
|
||||
"redfish_facts": {
|
||||
"data": {
|
||||
"@odata.etag": "\"3179bf00d69f25a8b3c\"",
|
||||
"@odata.id": "/redfish/v1/Managers/1/NetworkProtocol/Oem/Lenovo/DNS",
|
||||
"@odata.type": "#LenovoDNS.v1_0_0.LenovoDNS",
|
||||
"DDNS": [
|
||||
{
|
||||
"DDNSEnable": true,
|
||||
"DomainName": "",
|
||||
"DomainNameSource": "DHCP"
|
||||
}
|
||||
],
|
||||
"DNSEnable": true,
|
||||
"Description": "This resource is used to represent a DNS resource for a Redfish implementation.",
|
||||
"IPv4Address1": "10.103.62.178",
|
||||
"IPv4Address2": "0.0.0.0",
|
||||
"IPv4Address3": "0.0.0.0",
|
||||
"IPv6Address1": "::",
|
||||
"IPv6Address2": "::",
|
||||
"IPv6Address3": "::",
|
||||
"Id": "LenovoDNS",
|
||||
"PreferredAddresstype": "IPv4"
|
||||
},
|
||||
"ret": true
|
||||
}
|
||||
}
|
||||
}'
|
||||
"""
|
||||
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
|
|
|
@ -31,16 +31,15 @@ attributes:
|
|||
options:
|
||||
mime_types:
|
||||
description:
|
||||
- One or more MIME types for which a default handler will be set.
|
||||
- One or more MIME types for which a default handler is set.
|
||||
type: list
|
||||
elements: str
|
||||
required: true
|
||||
handler:
|
||||
description:
|
||||
- Sets the default handler for the specified MIME types.
|
||||
- The desktop file must be installed in the system.
|
||||
If the desktop file is not installed, the module
|
||||
does not fail, but the handler is not set either.
|
||||
- The desktop file must be installed in the system. If the desktop file is not installed, the module does not fail,
|
||||
but the handler is not set either.
|
||||
- You must pass a handler in the form V(*.desktop), otherwise the module fails.
|
||||
type: str
|
||||
required: true
|
||||
|
|
|
@ -394,141 +394,143 @@ instance:
|
|||
description: Metadata about the VM.
|
||||
returned: always
|
||||
type: dict
|
||||
sample: {
|
||||
"cdrom": {
|
||||
"type": "none"
|
||||
},
|
||||
"customization_agent": "native",
|
||||
"disks": [
|
||||
{
|
||||
"name": "testvm_11-0",
|
||||
"name_desc": "",
|
||||
"os_device": "xvda",
|
||||
"size": 42949672960,
|
||||
"sr": "Local storage",
|
||||
"sr_uuid": "0af1245e-bdb0-ba33-1446-57a962ec4075",
|
||||
"vbd_userdevice": "0"
|
||||
sample:
|
||||
{
|
||||
"cdrom": {
|
||||
"type": "none"
|
||||
},
|
||||
{
|
||||
"name": "testvm_11-1",
|
||||
"name_desc": "",
|
||||
"os_device": "xvdb",
|
||||
"size": 42949672960,
|
||||
"sr": "Local storage",
|
||||
"sr_uuid": "0af1245e-bdb0-ba33-1446-57a962ec4075",
|
||||
"vbd_userdevice": "1"
|
||||
"customization_agent": "native",
|
||||
"disks": [
|
||||
{
|
||||
"name": "testvm_11-0",
|
||||
"name_desc": "",
|
||||
"os_device": "xvda",
|
||||
"size": 42949672960,
|
||||
"sr": "Local storage",
|
||||
"sr_uuid": "0af1245e-bdb0-ba33-1446-57a962ec4075",
|
||||
"vbd_userdevice": "0"
|
||||
},
|
||||
{
|
||||
"name": "testvm_11-1",
|
||||
"name_desc": "",
|
||||
"os_device": "xvdb",
|
||||
"size": 42949672960,
|
||||
"sr": "Local storage",
|
||||
"sr_uuid": "0af1245e-bdb0-ba33-1446-57a962ec4075",
|
||||
"vbd_userdevice": "1"
|
||||
}
|
||||
],
|
||||
"domid": "56",
|
||||
"folder": "",
|
||||
"hardware": {
|
||||
"memory_mb": 8192,
|
||||
"num_cpu_cores_per_socket": 2,
|
||||
"num_cpus": 4
|
||||
},
|
||||
"home_server": "",
|
||||
"is_template": false,
|
||||
"name": "testvm_11",
|
||||
"name_desc": "",
|
||||
"networks": [
|
||||
{
|
||||
"gateway": "192.168.0.254",
|
||||
"gateway6": "fc00::fffe",
|
||||
"ip": "192.168.0.200",
|
||||
"ip6": [
|
||||
"fe80:0000:0000:0000:e9cb:625a:32c5:c291",
|
||||
"fc00:0000:0000:0000:0000:0000:0000:0001"
|
||||
],
|
||||
"mac": "ba:91:3a:48:20:76",
|
||||
"mtu": "1500",
|
||||
"name": "Pool-wide network associated with eth1",
|
||||
"netmask": "255.255.255.128",
|
||||
"prefix": "25",
|
||||
"prefix6": "64",
|
||||
"vif_device": "0"
|
||||
}
|
||||
],
|
||||
"other_config": {
|
||||
"base_template_name": "Windows Server 2016 (64-bit)",
|
||||
"import_task": "OpaqueRef:e43eb71c-45d6-5351-09ff-96e4fb7d0fa5",
|
||||
"install-methods": "cdrom",
|
||||
"instant": "true",
|
||||
"mac_seed": "f83e8d8a-cfdc-b105-b054-ef5cb416b77e"
|
||||
},
|
||||
"platform": {
|
||||
"acpi": "1",
|
||||
"apic": "true",
|
||||
"cores-per-socket": "2",
|
||||
"device_id": "0002",
|
||||
"hpet": "true",
|
||||
"nx": "true",
|
||||
"pae": "true",
|
||||
"timeoffset": "-25200",
|
||||
"vga": "std",
|
||||
"videoram": "8",
|
||||
"viridian": "true",
|
||||
"viridian_reference_tsc": "true",
|
||||
"viridian_time_ref_count": "true"
|
||||
},
|
||||
"state": "poweredon",
|
||||
"uuid": "e3c0b2d5-5f05-424e-479c-d3df8b3e7cda",
|
||||
"xenstore_data": {
|
||||
"vm-data": ""
|
||||
}
|
||||
],
|
||||
"domid": "56",
|
||||
"folder": "",
|
||||
"hardware": {
|
||||
"memory_mb": 8192,
|
||||
"num_cpu_cores_per_socket": 2,
|
||||
"num_cpus": 4
|
||||
},
|
||||
"home_server": "",
|
||||
"is_template": false,
|
||||
"name": "testvm_11",
|
||||
"name_desc": "",
|
||||
"networks": [
|
||||
{
|
||||
"gateway": "192.168.0.254",
|
||||
"gateway6": "fc00::fffe",
|
||||
"ip": "192.168.0.200",
|
||||
"ip6": [
|
||||
"fe80:0000:0000:0000:e9cb:625a:32c5:c291",
|
||||
"fc00:0000:0000:0000:0000:0000:0000:0001"
|
||||
],
|
||||
"mac": "ba:91:3a:48:20:76",
|
||||
"mtu": "1500",
|
||||
"name": "Pool-wide network associated with eth1",
|
||||
"netmask": "255.255.255.128",
|
||||
"prefix": "25",
|
||||
"prefix6": "64",
|
||||
"vif_device": "0"
|
||||
}
|
||||
],
|
||||
"other_config": {
|
||||
"base_template_name": "Windows Server 2016 (64-bit)",
|
||||
"import_task": "OpaqueRef:e43eb71c-45d6-5351-09ff-96e4fb7d0fa5",
|
||||
"install-methods": "cdrom",
|
||||
"instant": "true",
|
||||
"mac_seed": "f83e8d8a-cfdc-b105-b054-ef5cb416b77e"
|
||||
},
|
||||
"platform": {
|
||||
"acpi": "1",
|
||||
"apic": "true",
|
||||
"cores-per-socket": "2",
|
||||
"device_id": "0002",
|
||||
"hpet": "true",
|
||||
"nx": "true",
|
||||
"pae": "true",
|
||||
"timeoffset": "-25200",
|
||||
"vga": "std",
|
||||
"videoram": "8",
|
||||
"viridian": "true",
|
||||
"viridian_reference_tsc": "true",
|
||||
"viridian_time_ref_count": "true"
|
||||
},
|
||||
"state": "poweredon",
|
||||
"uuid": "e3c0b2d5-5f05-424e-479c-d3df8b3e7cda",
|
||||
"xenstore_data": {
|
||||
"vm-data": ""
|
||||
}
|
||||
}
|
||||
changes:
|
||||
description: Detected or made changes to VM.
|
||||
returned: always
|
||||
type: list
|
||||
sample: [
|
||||
{
|
||||
"hardware": [
|
||||
"num_cpus"
|
||||
]
|
||||
},
|
||||
{
|
||||
"disks_changed": [
|
||||
[],
|
||||
[
|
||||
"size"
|
||||
sample:
|
||||
[
|
||||
{
|
||||
"hardware": [
|
||||
"num_cpus"
|
||||
]
|
||||
]
|
||||
},
|
||||
{
|
||||
"disks_new": [
|
||||
{
|
||||
"name": "new-disk",
|
||||
"name_desc": "",
|
||||
"position": 2,
|
||||
"size_gb": "4",
|
||||
"vbd_userdevice": "2"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"cdrom": [
|
||||
"type",
|
||||
"iso_name"
|
||||
]
|
||||
},
|
||||
{
|
||||
"networks_changed": [
|
||||
[
|
||||
"mac"
|
||||
],
|
||||
]
|
||||
},
|
||||
{
|
||||
"networks_new": [
|
||||
{
|
||||
"name": "Pool-wide network associated with eth2",
|
||||
"position": 1,
|
||||
"vif_device": "1"
|
||||
}
|
||||
]
|
||||
},
|
||||
"need_poweredoff"
|
||||
]
|
||||
},
|
||||
{
|
||||
"disks_changed": [
|
||||
[],
|
||||
[
|
||||
"size"
|
||||
]
|
||||
]
|
||||
},
|
||||
{
|
||||
"disks_new": [
|
||||
{
|
||||
"name": "new-disk",
|
||||
"name_desc": "",
|
||||
"position": 2,
|
||||
"size_gb": "4",
|
||||
"vbd_userdevice": "2"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"cdrom": [
|
||||
"type",
|
||||
"iso_name"
|
||||
]
|
||||
},
|
||||
{
|
||||
"networks_changed": [
|
||||
[
|
||||
"mac"
|
||||
]
|
||||
]
|
||||
},
|
||||
{
|
||||
"networks_new": [
|
||||
{
|
||||
"name": "Pool-wide network associated with eth2",
|
||||
"position": 1,
|
||||
"vif_device": "1"
|
||||
}
|
||||
]
|
||||
},
|
||||
"need_poweredoff"
|
||||
]
|
||||
"""
|
||||
|
||||
import re
|
||||
|
|
|
@ -333,7 +333,15 @@ actions:
|
|||
description: A dictionary with the original xpath, namespaces and state.
|
||||
type: dict
|
||||
returned: success
|
||||
sample: {xpath: xpath, namespaces: [namespace1, namespace2], state: present}
|
||||
sample:
|
||||
{
|
||||
"xpath": "xpath",
|
||||
"namespaces": [
|
||||
"namespace1",
|
||||
"namespace2"
|
||||
],
|
||||
"state": "present"
|
||||
}
|
||||
backup_file:
|
||||
description: The name of the backup file that was created.
|
||||
type: str
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue