mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-08-05 21:54:22 -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,7 +273,8 @@ redfish_facts:
|
||||||
description: Resource content.
|
description: Resource content.
|
||||||
returned: when command == GetResource or command == GetCollectionResource
|
returned: when command == GetResource or command == GetCollectionResource
|
||||||
type: dict
|
type: dict
|
||||||
sample: '{
|
sample:
|
||||||
|
{
|
||||||
"redfish_facts": {
|
"redfish_facts": {
|
||||||
"data": {
|
"data": {
|
||||||
"@odata.etag": "\"3179bf00d69f25a8b3c\"",
|
"@odata.etag": "\"3179bf00d69f25a8b3c\"",
|
||||||
|
@ -299,7 +300,7 @@ redfish_facts:
|
||||||
},
|
},
|
||||||
"ret": true
|
"ret": true
|
||||||
}
|
}
|
||||||
}'
|
}
|
||||||
"""
|
"""
|
||||||
|
|
||||||
from ansible.module_utils.basic import AnsibleModule
|
from ansible.module_utils.basic import AnsibleModule
|
||||||
|
|
|
@ -31,16 +31,15 @@ attributes:
|
||||||
options:
|
options:
|
||||||
mime_types:
|
mime_types:
|
||||||
description:
|
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
|
type: list
|
||||||
elements: str
|
elements: str
|
||||||
required: true
|
required: true
|
||||||
handler:
|
handler:
|
||||||
description:
|
description:
|
||||||
- Sets the default handler for the specified MIME types.
|
- Sets the default handler for the specified MIME types.
|
||||||
- The desktop file must be installed in the system.
|
- The desktop file must be installed in the system. If the desktop file is not installed, the module does not fail,
|
||||||
If the desktop file is not installed, the module
|
but the handler is not set either.
|
||||||
does not fail, but the handler is not set either.
|
|
||||||
- You must pass a handler in the form V(*.desktop), otherwise the module fails.
|
- You must pass a handler in the form V(*.desktop), otherwise the module fails.
|
||||||
type: str
|
type: str
|
||||||
required: true
|
required: true
|
||||||
|
|
|
@ -394,7 +394,8 @@ instance:
|
||||||
description: Metadata about the VM.
|
description: Metadata about the VM.
|
||||||
returned: always
|
returned: always
|
||||||
type: dict
|
type: dict
|
||||||
sample: {
|
sample:
|
||||||
|
{
|
||||||
"cdrom": {
|
"cdrom": {
|
||||||
"type": "none"
|
"type": "none"
|
||||||
},
|
},
|
||||||
|
@ -480,7 +481,8 @@ changes:
|
||||||
description: Detected or made changes to VM.
|
description: Detected or made changes to VM.
|
||||||
returned: always
|
returned: always
|
||||||
type: list
|
type: list
|
||||||
sample: [
|
sample:
|
||||||
|
[
|
||||||
{
|
{
|
||||||
"hardware": [
|
"hardware": [
|
||||||
"num_cpus"
|
"num_cpus"
|
||||||
|
@ -515,7 +517,7 @@ changes:
|
||||||
"networks_changed": [
|
"networks_changed": [
|
||||||
[
|
[
|
||||||
"mac"
|
"mac"
|
||||||
],
|
]
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
|
|
|
@ -333,7 +333,15 @@ actions:
|
||||||
description: A dictionary with the original xpath, namespaces and state.
|
description: A dictionary with the original xpath, namespaces and state.
|
||||||
type: dict
|
type: dict
|
||||||
returned: success
|
returned: success
|
||||||
sample: {xpath: xpath, namespaces: [namespace1, namespace2], state: present}
|
sample:
|
||||||
|
{
|
||||||
|
"xpath": "xpath",
|
||||||
|
"namespaces": [
|
||||||
|
"namespace1",
|
||||||
|
"namespace2"
|
||||||
|
],
|
||||||
|
"state": "present"
|
||||||
|
}
|
||||||
backup_file:
|
backup_file:
|
||||||
description: The name of the backup file that was created.
|
description: The name of the backup file that was created.
|
||||||
type: str
|
type: str
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue