ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-04-25 20:01:25 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 9

Use semantic markup (modules o-p) (#6681)

Browse source 
* Use semantic markup.

* Use real option, not alias.

* E() now works better.
This commit is contained in:
Felix Fontein 2023-06-15 15:48:17 +02:00 • committed by GitHub
parent b271dba4bf
commit 45eb1e3915
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
42 changed files with 420 additions and 419 deletions
Download patch file Download diff file Expand all files Collapse all files

16
plugins/modules/ocapi_info.py
View file

@ -38,7 +38,7 @@ options:
- Base URI of OOB controller.
type: str
proxy_slot_number:
description: For proxied inband requests, the slot number of the IOM. Only applies if I(baseuri) is a proxy server.
description: For proxied inband requests, the slot number of the IOM. Only applies if O(baseuri) is a proxy server.
type: int
username:
required: true
@ -83,45 +83,45 @@ msg:
sample: "Action was successful"
percentComplete:
description: Percent complete of the relevant operation. Applies to C(JobStatus) command.
description: Percent complete of the relevant operation. Applies to O(command=JobStatus).
returned: when supported
type: int
sample: 99
operationStatus:
description: Status of the relevant operation. Applies to C(JobStatus) command. See OCAPI documentation for details.
description: Status of the relevant operation. Applies to O(command=JobStatus). See OCAPI documentation for details.
returned: when supported
type: str
sample: "Activate needed"
operationStatusId:
description: Integer value of status (corresponds to operationStatus). Applies to C(JobStatus) command. See OCAPI documentation for details.
description: Integer value of status (corresponds to operationStatus). Applies to O(command=JobStatus). See OCAPI documentation for details.
returned: when supported
type: int
sample: 65540
operationHealth:
description: Health of the operation. Applies to C(JobStatus) command. See OCAPI documentation for details.
description: Health of the operation. Applies to O(command=JobStatus). See OCAPI documentation for details.
returned: when supported
type: str
sample: "OK"
operationHealthId:
description: >
Integer value for health of the operation (corresponds to C(operationHealth)). Applies to C(JobStatus) command.
Integer value for health of the operation (corresponds to RV(operationHealth)). Applies to O(command=JobStatus).
See OCAPI documentation for details.
returned: when supported
type: str
sample: "OK"
details:
description: Details of the relevant operation. Applies to C(JobStatus) command.
description: Details of the relevant operation. Applies to O(command=JobStatus).
returned: when supported
type: list
elements: str
status:
description: Dict containing status information. See OCAPI documentation for details.
description: Dictionary containing status information. See OCAPI documentation for details.
returned: when supported
type: dict
sample: {