Nosh module documentation update (#63303)

* detail the 'status' dictionary
* did not add individual descriptions, see nosh documentation for those
* sample: False not being rendered unless 'False' is quoted
pull/62303/head
tacatac 5 years ago committed by Alicia Cozine
parent 7f4befdea7
commit df283788e5

@ -125,7 +125,7 @@ preset:
description: whether the enabled status reflects the one set in the relevant C(*.preset) file description: whether the enabled status reflects the one set in the relevant C(*.preset) file
returned: success returned: success
type: bool type: bool
sample: False sample: 'False'
state: state:
description: service process run state, C(None) if the service is not loaded and will not be started description: service process run state, C(None) if the service is not loaded and will not be started
returned: if state option is used returned: if state option is used
@ -135,56 +135,143 @@ status:
description: a dictionary with the key=value pairs returned by `system-control show-json` or C(None) if the service is not loaded description: a dictionary with the key=value pairs returned by `system-control show-json` or C(None) if the service is not loaded
returned: success returned: success
type: complex type: complex
contains: { contains:
"After": [ After:
"/etc/service-bundles/targets/basic", returned: success
"../sshdgenkeys", type: list
"log" sample: ["/etc/service-bundles/targets/basic","../sshdgenkeys", "log"]
], Before:
"Before": [ returned: success
"/etc/service-bundles/targets/shutdown" type: list
], sample: ["/etc/service-bundles/targets/shutdown"]
"Conflicts": [], Conflicts:
"DaemontoolsEncoreState": "running", returned: success
"DaemontoolsState": "up", type: list
"Enabled": true, sample: '[]'
"LogService": "../cyclog@sshd", DaemontoolsEncoreState:
"MainPID": 661, returned: success
"Paused": false, type: str
"ReadyAfterRun": false, sample: "running"
"RemainAfterExit": false, DaemontoolsState:
"Required-By": [], returned: success
"RestartExitStatusCode": 0, type: str
"RestartExitStatusNumber": 0, sample: "up"
"RestartTimestamp": 4611686019935648081, Enabled:
"RestartUTCTimestamp": 1508260140, returned: success
"RunExitStatusCode": 0, type: bool
"RunExitStatusNumber": 0, sample: True
"RunTimestamp": 4611686019935648081, LogService:
"RunUTCTimestamp": 1508260140, returned: success
"StartExitStatusCode": 1, type: str
"StartExitStatusNumber": 0, sample: "../cyclog@sshd"
"StartTimestamp": 4611686019935648081, MainPID:
"StartUTCTimestamp": 1508260140, returned: success
"StopExitStatusCode": 0, type: int
"StopExitStatusNumber": 0, sample: 661
"StopTimestamp": 4611686019935648081, Paused:
"StopUTCTimestamp": 1508260140, returned: success
"Stopped-By": [ type: bool
"/etc/service-bundles/targets/shutdown" sample: 'False'
], ReadyAfterRun:
"Timestamp": 4611686019935648081, returned: success
"UTCTimestamp": 1508260140, type: bool
"Want": "nothing", sample: 'False'
"Wanted-By": [ RemainAfterExit:
"/etc/service-bundles/targets/server", returned: success
"/etc/service-bundles/targets/sockets" type: bool
], sample: 'False'
"Wants": [ Required-By:
"/etc/service-bundles/targets/basic", returned: success
"../sshdgenkeys" type: list
] sample: '[]'
} RestartExitStatusCode:
returned: success
type: int
sample: '0'
RestartExitStatusNumber:
returned: success
type: int
sample: '0'
RestartTimestamp:
returned: success
type: int
sample: 4611686019935648081
RestartUTCTimestamp:
returned: success
type: int
sample: 1508260140
RunExitStatusCode:
returned: success
type: int
sample: '0'
RunExitStatusNumber:
returned: success
type: int
sample: '0'
RunTimestamp:
returned: success
type: int
sample: 4611686019935648081
RunUTCTimestamp:
returned: success
type: int
sample: 1508260140
StartExitStatusCode:
returned: success
type: int
sample: 1
StartExitStatusNumber:
returned: success
type: int
sample: '0'
StartTimestamp:
returned: success
type: int
sample: 4611686019935648081
StartUTCTimestamp:
returned: success
type: int
sample: 1508260140
StopExitStatusCode:
returned: success
type: int
sample: '0'
StopExitStatusNumber:
returned: success
type: int
sample: '0'
StopTimestamp:
returned: success
type: int
sample: 4611686019935648081
StopUTCTimestamp:
returned: success
type: int
sample: 1508260140
Stopped-By:
returned: success
type: list
sample: ["/etc/service-bundles/targets/shutdown"]
Timestamp:
returned: success
type: int
sample: 4611686019935648081
UTCTimestamp:
returned: success
type: int
sample: 1508260140
Want:
returned: success
type: str
sample: "nothing"
Wanted-By:
returned: success
type: list
sample: ["/etc/service-bundles/targets/server","/etc/service-bundles/targets/sockets"]
Wants:
returned: success
type: list
sample: ["/etc/service-bundles/targets/basic","../sshdgenkeys"]
user: user:
description: whether the user-level service manager is called description: whether the user-level service manager is called
returned: success returned: success

Loading…
Cancel
Save