mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-05-29 04:19:15 -07:00
Fix docs. (#5063)
This commit is contained in:
parent
4eb3540c8e
commit
f67473024d
22 changed files with 72 additions and 96 deletions
|
@ -88,7 +88,7 @@ msg:
|
|||
description: The command standard output
|
||||
returned: always
|
||||
type: str
|
||||
sample: [u'Using default tag: latest ...']
|
||||
sample: 'Using default tag: latest ...'
|
||||
'''
|
||||
|
||||
# import module snippets
|
||||
|
|
|
@ -64,7 +64,7 @@ msg:
|
|||
description: The command standard output
|
||||
returned: always
|
||||
type: str
|
||||
sample: [u'Using default tag: latest ...']
|
||||
sample: 'Using default tag: latest ...'
|
||||
'''
|
||||
import traceback
|
||||
|
||||
|
|
|
@ -152,7 +152,7 @@ options:
|
|||
description:
|
||||
- Set status of Lassie watchdog.
|
||||
type: bool
|
||||
default: "True"
|
||||
default: true
|
||||
requirements:
|
||||
- python >= 2.6
|
||||
- linode-python
|
||||
|
|
|
@ -393,7 +393,7 @@ actions:
|
|||
description: List of actions performed for the instance.
|
||||
returned: success
|
||||
type: list
|
||||
sample: '["create", "start"]'
|
||||
sample: ["create", "start"]
|
||||
'''
|
||||
import datetime
|
||||
import os
|
||||
|
|
|
@ -222,7 +222,7 @@ actions:
|
|||
description: List of actions performed for the profile.
|
||||
returned: success
|
||||
type: list
|
||||
sample: '["create"]'
|
||||
sample: ["create"]
|
||||
'''
|
||||
|
||||
import os
|
||||
|
|
|
@ -148,7 +148,7 @@ vm:
|
|||
description: Returns all of the VMs variables and execution.
|
||||
returned: always
|
||||
type: dict
|
||||
sample: '{
|
||||
sample: {
|
||||
"boot_order": [
|
||||
"hd",
|
||||
"network"
|
||||
|
@ -206,7 +206,7 @@ vm:
|
|||
"vmcpu": "4",
|
||||
"vmhost": "host416",
|
||||
"vmmem": "16"
|
||||
}'
|
||||
}
|
||||
'''
|
||||
|
||||
EXAMPLES = r'''
|
||||
|
|
|
@ -212,7 +212,8 @@ RETURN = '''
|
|||
servers:
|
||||
description: Information about each server that was processed
|
||||
type: list
|
||||
sample: '[{"hostname": "my-server", "id": "server-id"}]'
|
||||
sample:
|
||||
- {"hostname": "my-server", "id": "server-id"}
|
||||
returned: always
|
||||
'''
|
||||
|
||||
|
|
|
@ -234,8 +234,9 @@ roles:
|
|||
description: list of dictionaries of roles, each role is described by name, cardinality, state and nodes ids
|
||||
type: list
|
||||
returned: success
|
||||
sample: '[{"cardinality": 1,"name": "foo","state": "RUNNING","ids": [ 123, 456 ]},
|
||||
{"cardinality": 2,"name": "bar","state": "RUNNING", "ids": [ 452, 567, 746 ]}]'
|
||||
sample:
|
||||
- {"cardinality": 1,"name": "foo","state": "RUNNING", "ids": [ 123, 456 ]}
|
||||
- {"cardinality": 2,"name": "bar","state": "RUNNING", "ids": [ 452, 567, 746 ]}
|
||||
'''
|
||||
|
||||
import os
|
||||
|
|
|
@ -261,10 +261,17 @@ changed:
|
|||
devices:
|
||||
description: Information about each device that was processed
|
||||
type: list
|
||||
sample: '[{"hostname": "my-server.com", "id": "2a5122b9-c323-4d5c-b53c-9ad3f54273e7",
|
||||
"public_ipv4": "147.229.15.12", "private-ipv4": "10.0.15.12",
|
||||
"tags": [], "locked": false, "state": "provisioning",
|
||||
"public_ipv6": ""2604:1380:2:5200::3"}]'
|
||||
sample:
|
||||
- {
|
||||
"hostname": "my-server.com",
|
||||
"id": "2a5122b9-c323-4d5c-b53c-9ad3f54273e7",
|
||||
"public_ipv4": "147.229.15.12",
|
||||
"private-ipv4": "10.0.15.12",
|
||||
"tags": [],
|
||||
"locked": false,
|
||||
"state": "provisioning",
|
||||
"public_ipv6": "2604:1380:2:5200::3"
|
||||
}
|
||||
returned: success
|
||||
''' # NOQA
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue