ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-06-27 10:40:22 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

Adjust YAML in module docs (#10240)

Browse source 
* Adjust YAML in module docs.

* adjust modules

---------

Co-authored-by: Alexei Znamensky <russoz@gmail.com>
This commit is contained in:
Felix Fontein 2025-06-16 17:45:12 +02:00 • committed by GitHub
parent e938ca5f20
commit e8f965fbf8
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
89 changed files with 2085 additions and 1675 deletions
Download patch file Download diff file Expand all files Collapse all files

49
plugins/modules/campfire.py
View file

@ -48,10 +48,51 @@ options:
description: description:
- Send a notification sound before the message. - Send a notification sound before the message.
required: false required: false
choices: ["56k", "bell", "bezos", "bueller", "clowntown", "cottoneyejoe", "crickets", "dadgummit", "dangerzone", "danielsan", choices:
"deeper", "drama", "greatjob", "greyjoy", "guarantee", "heygirl", "horn", "horror", "inconceivable", "live", "loggins", - 56k
"makeitso", "noooo", "nyan", "ohmy", "ohyeah", "pushit", "rimshot", "rollout", "rumble", "sax", "secret", "sexyback", - bell
"story", "tada", "tmyk", "trololo", "trombone", "unix", "vuvuzela", "what", "whoomp", "yeah", "yodel"] - bezos
- bueller
- clowntown
- cottoneyejoe
- crickets
- dadgummit
- dangerzone
- danielsan
- deeper
- drama
- greatjob
- greyjoy
- guarantee
- heygirl
- horn
- horror
- inconceivable
- live
- loggins
- makeitso
- noooo
- nyan
- ohmy
- ohyeah
- pushit
- rimshot
- rollout
- rumble
- sax
- secret
- sexyback
- story
- tada
- tmyk
- trololo
- trombone
- unix
- vuvuzela
- what
- whoomp
- yeah
- yodel
# informational: requirements for nodes # informational: requirements for nodes
requirements: [] requirements: []

17
plugins/modules/cloudflare_dns.py
View file

@ -345,8 +345,16 @@ record:
description: Additional record data. description: Additional record data.
returned: success, if type is SRV, DS, SSHFP TLSA or CAA returned: success, if type is SRV, DS, SSHFP TLSA or CAA
type: dict type: dict
sample: {name: "jabber", port: 8080, priority: 10, proto: "_tcp", service: "_xmpp", target: "jabberhost.sample.com", sample:
weight: 5} {
"name": "jabber",
"port": 8080,
"priority": 10,
"proto": "_tcp",
"service": "_xmpp",
"target": "jabberhost.sample.com",
"weight": 5
}
id: id:
description: The record ID. description: The record ID.
returned: success returned: success
@ -361,7 +369,10 @@ record:
description: Extra Cloudflare-specific information about the record. description: Extra Cloudflare-specific information about the record.
returned: success returned: success
type: dict type: dict
sample: {auto_added: false} sample:
{
"auto_added": false
}
modified_on: modified_on:
description: Record modification date. description: Record modification date.
returned: success returned: success

25
plugins/modules/consul_role.py
View file

@ -182,17 +182,20 @@ role:
returned: success returned: success
type: dict type: dict
sample: sample:
{ {
"CreateIndex": 39, "CreateIndex": 39,
"Description": "", "Description": "",
"Hash": "Trt0QJtxVEfvTTIcdTUbIJRr6Dsi6E4EcwSFxx9tCYM=", "Hash": "Trt0QJtxVEfvTTIcdTUbIJRr6Dsi6E4EcwSFxx9tCYM=",
"ID": "9a300b8d-48db-b720-8544-a37c0f5dafb5", "ID": "9a300b8d-48db-b720-8544-a37c0f5dafb5",
"ModifyIndex": 39, "ModifyIndex": 39,
"Name": "foo-role", "Name": "foo-role",
"Policies": [ "Policies": [
{"ID": "b1a00172-d7a1-0e66-a12e-7a4045c4b774", "Name": "foo-access"} {
] "ID": "b1a00172-d7a1-0e66-a12e-7a4045c4b774",
} "Name": "foo-access"
}
]
}
operation: operation:
description: The operation performed on the role. description: The operation performed on the role.
returned: changed returned: changed

49
plugins/modules/datadog_downtime.py
View file

@ -126,30 +126,31 @@ RETURN = r"""
# Returns the downtime JSON dictionary from the API response under the C(downtime) key. # Returns the downtime JSON dictionary from the API response under the C(downtime) key.
# See https://docs.datadoghq.com/api/v1/downtimes/#schedule-a-downtime for more details. # See https://docs.datadoghq.com/api/v1/downtimes/#schedule-a-downtime for more details.
downtime: downtime:
description: The downtime returned by the API. description: The downtime returned by the API.
type: dict type: dict
returned: always returned: always
sample: { sample:
"active": true, {
"canceled": null, "active": true,
"creator_id": 1445416, "canceled": null,
"disabled": false, "creator_id": 1445416,
"downtime_type": 2, "disabled": false,
"end": null, "downtime_type": 2,
"id": 1055751000, "end": null,
"message": "Downtime for foo:bar", "id": 1055751000,
"monitor_id": null, "message": "Downtime for foo:bar",
"monitor_tags": [ "monitor_id": null,
"foo:bar" "monitor_tags": [
], "foo:bar"
"parent_id": null, ],
"recurrence": null, "parent_id": null,
"scope": [ "recurrence": null,
"test" "scope": [
], "test"
"start": 1607015009, ],
"timezone": "UTC", "start": 1607015009,
"updater_id": null "timezone": "UTC",
"updater_id": null
} }
""" """

21
plugins/modules/dnsimple.py
View file

@ -51,8 +51,23 @@ options:
type: type:
description: description:
- The type of DNS record to create. - The type of DNS record to create.
choices: ['A', 'ALIAS', 'CNAME', 'MX', 'SPF', 'URL', 'TXT', 'NS', 'SRV', 'NAPTR', 'PTR', 'AAAA', 'SSHFP', 'HINFO', 'POOL', choices:
'CAA'] - A
- ALIAS
- CNAME
- MX
- SPF
- URL
- TXT
- NS
- SRV
- NAPTR
- PTR
- AAAA
- SSHFP
- HINFO
- POOL
- CAA
type: str type: str
ttl: ttl:
description: description:
@ -151,7 +166,7 @@ EXAMPLES = r"""
delegate_to: localhost delegate_to: localhost
""" """
RETURN = r"""# """ RETURN = r"""#"""
import traceback import traceback
import re import re

8
plugins/modules/dpkg_divert.py
View file

@ -132,7 +132,13 @@ diversion:
state: state:
description: The state of the diversion. description: The state of the diversion.
type: str type: str
sample: {"divert": "/etc/foobarrc.distrib", "holder": "LOCAL", "path": "/etc/foobarrc", "state": "present"} sample:
{
"divert": "/etc/foobarrc.distrib",
"holder": "LOCAL",
"path": "/etc/foobarrc",
"state": "present"
}
""" """

34
plugins/modules/github_key.py
View file

@ -64,20 +64,42 @@ deleted_keys:
description: An array of key objects that were deleted. Only present on state=absent. description: An array of key objects that were deleted. Only present on state=absent.
type: list type: list
returned: When state=absent returned: When state=absent
sample: [{'id': 0, 'key': 'BASE64 encoded key', 'url': 'http://example.com/github key', 'created_at': 'YYYY-MM-DDTHH:MM:SZ', sample:
'read_only': false}] [
{
"id": 0,
"key": "BASE64 encoded key",
"url": "http://example.com/github key",
"created_at": "YYYY-MM-DDTHH:MM:SZ",
"read_only": false
}
]
matching_keys: matching_keys:
description: An array of keys matching the specified name. Only present on state=present. description: An array of keys matching the specified name. Only present on state=present.
type: list type: list
returned: When state=present returned: When state=present
sample: [{'id': 0, 'key': 'BASE64 encoded key', 'url': 'http://example.com/github key', 'created_at': 'YYYY-MM-DDTHH:MM:SZ', sample:
'read_only': false}] [
{
"id": 0,
"key": "BASE64 encoded key",
"url": "http://example.com/github key",
"created_at": "YYYY-MM-DDTHH:MM:SZ",
"read_only": false
}
]
key: key:
description: Metadata about the key just created. Only present on state=present. description: Metadata about the key just created. Only present on state=present.
type: dict type: dict
returned: success returned: success
sample: {'id': 0, 'key': 'BASE64 encoded key', 'url': 'http://example.com/github key', 'created_at': 'YYYY-MM-DDTHH:MM:SZ', sample:
'read_only': false} {
"id": 0,
"key": "BASE64 encoded key",
"url": "http://example.com/github key",
"created_at": "YYYY-MM-DDTHH:MM:SZ",
"read_only": false
}
""" """
EXAMPLES = r""" EXAMPLES = r"""

21
plugins/modules/github_webhook_info.py
View file

@ -76,16 +76,17 @@ hooks:
type: list type: list
elements: dict elements: dict
sample: sample:
- { - has_shared_secret: true
"has_shared_secret": true, url: https://jenkins.example.com/ghprbhook/
"url": "https://jenkins.example.com/ghprbhook/", events: [issue_comment, pull_request]
"events": ["issue_comment", "pull_request"], insecure_ssl: "1"
"insecure_ssl": "1", content_type: json
"content_type": "json", active: true
"active": true, id: 6206
"id": 6206, last_response:
"last_response": {"status": "active", "message": "OK", "code": 200} status: active
} message: OK
code: 200
""" """
import traceback import traceback

12
plugins/modules/gitlab_group_access_token.py
View file

@ -55,8 +55,16 @@ options:
type: list type: list
elements: str elements: str
aliases: ["scope"] aliases: ["scope"]
choices: ["api", "read_api", "read_registry", "write_registry", "read_repository", "write_repository", "create_runner", choices:
"ai_features", "k8s_proxy"] - api
- read_api
- read_registry
- write_registry
- read_repository
- write_repository
- create_runner
- ai_features
- k8s_proxy
access_level: access_level:
description: description:
- Access level of the access token. - Access level of the access token.

12
plugins/modules/gitlab_project_access_token.py
View file

@ -55,8 +55,16 @@ options:
type: list type: list
elements: str elements: str
aliases: ["scope"] aliases: ["scope"]
choices: ["api", "read_api", "read_registry", "write_registry", "read_repository", "write_repository", "create_runner", choices:
"ai_features", "k8s_proxy"] - api
- read_api
- read_registry
- write_registry
- read_repository
- write_repository
- create_runner
- ai_features
- k8s_proxy
access_level: access_level:
description: description:
- Access level of the access token. - Access level of the access token.

93
plugins/modules/homectl.py
View file

@ -218,53 +218,54 @@ EXAMPLES = r"""
RETURN = r""" RETURN = r"""
data: data:
description: Dictionary returned from C(homectl inspect -j). description: Dictionary returned from C(homectl inspect -j).
returned: success returned: success
type: dict type: dict
sample: { sample:
"data": { {
"binding": { "data": {
"e9ed2a5b0033427286b228e97c1e8343": { "binding": {
"fileSystemType": "btrfs", "e9ed2a5b0033427286b228e97c1e8343": {
"fileSystemUuid": "7bd59491-2812-4642-a492-220c3f0c6c0b", "fileSystemType": "btrfs",
"gid": 60268, "fileSystemUuid": "7bd59491-2812-4642-a492-220c3f0c6c0b",
"imagePath": "/home/james.home", "gid": 60268,
"luksCipher": "aes", "imagePath": "/home/james.home",
"luksCipherMode": "xts-plain64", "luksCipher": "aes",
"luksUuid": "7f05825a-2c38-47b4-90e1-f21540a35a81", "luksCipherMode": "xts-plain64",
"luksVolumeKeySize": 32, "luksUuid": "7f05825a-2c38-47b4-90e1-f21540a35a81",
"partitionUuid": "5a906126-d3c8-4234-b230-8f6e9b427b2f", "luksVolumeKeySize": 32,
"storage": "luks", "partitionUuid": "5a906126-d3c8-4234-b230-8f6e9b427b2f",
"uid": 60268 "storage": "luks",
} "uid": 60268
}, }
},
"diskSize": 3221225472,
"disposition": "regular",
"lastChangeUSec": 1641941238208691,
"lastPasswordChangeUSec": 1641941238208691,
"privileged": {
"hashedPassword": [
"$6$ov9AKni.trf76inT$tTtfSyHgbPTdUsG0CvSSQZXGqFGdHKQ9Pb6e0BTZhDmlgrL/vA5BxrXduBi8u/PCBiYUffGLIkGhApjKMK3bV."
]
},
"signature": [
{
"data": "o6zVFbymcmk4YTVaY6KPQK23YCp+VkXdGEeniZeV1pzIbFzoaZBvVLPkNKMoPAQbodY5BYfBtuy41prNL78qAg==",
"key": "-----BEGIN PUBLIC KEY-----\nMCowBQYDK2VwAyEAbs7ELeiEYBxkUQhxZ+5NGyu6J7gTtZtZ5vmIw3jowcY=\n-----END PUBLIC KEY-----\n"
}
],
"status": {
"e9ed2a5b0033427286b228e97c1e8343": {
"diskCeiling": 21845405696,
"diskFloor": 268435456,
"diskSize": 3221225472, "diskSize": 3221225472,
"disposition": "regular", "service": "io.systemd.Home",
"lastChangeUSec": 1641941238208691, "signedLocally": true,
"lastPasswordChangeUSec": 1641941238208691, "state": "inactive"
"privileged": { }
"hashedPassword": [ },
"$6$ov9AKni.trf76inT$tTtfSyHgbPTdUsG0CvSSQZXGqFGdHKQ9Pb6e0BTZhDmlgrL/vA5BxrXduBi8u/PCBiYUffGLIkGhApjKMK3bV." "userName": "james"
] }
},
"signature": [
{
"data": "o6zVFbymcmk4YTVaY6KPQK23YCp+VkXdGEeniZeV1pzIbFzoaZBvVLPkNKMoPAQbodY5BYfBtuy41prNL78qAg==",
"key": "-----BEGIN PUBLIC KEY-----\nMCowBQYDK2VwAyEAbs7ELeiEYBxkUQhxZ+5NGyu6J7gTtZtZ5vmIw3jowcY=\n-----END PUBLIC KEY-----\n"
}
],
"status": {
"e9ed2a5b0033427286b228e97c1e8343": {
"diskCeiling": 21845405696,
"diskFloor": 268435456,
"diskSize": 3221225472,
"service": "io.systemd.Home",
"signedLocally": true,
"state": "inactive"
}
},
"userName": "james",
}
} }
""" """

2
plugins/modules/honeybadger_deployment.py
View file

@ -67,7 +67,7 @@ EXAMPLES = r"""
repo: 'git@github.com:user/repo.git' repo: 'git@github.com:user/repo.git'
""" """
RETURN = """# """ RETURN = """#"""
import traceback import traceback

2
plugins/modules/infinity.py
View file

@ -126,7 +126,7 @@ network_info:
"network_size": null, "network_size": null,
"description": null, "description": null,
"network_location": "3085", "network_location": "3085",
"ranges": { "id": 0, "name": null,"first_ip": null,"type": null,"last_ip": null}, "ranges": {"id": 0, "name": null, "first_ip": null, "type": null, "last_ip": null},
"network_type": "lan", "network_type": "lan",
"network_name": "'reserve_new_ansible_network'" "network_name": "'reserve_new_ansible_network'"
} }

4
plugins/modules/influxdb_user.py
View file

@ -101,9 +101,7 @@ EXAMPLES = r"""
state: absent state: absent
""" """
RETURN = r""" RETURN = r"""#"""
#only defaults
"""
import json import json

12
plugins/modules/ipmi_power.py
View file

@ -111,7 +111,17 @@ status:
targetAddress: targetAddress:
description: The remote target address. description: The remote target address.
type: int type: int
sample: [{"powerstate": "on", "targetAddress": 48}, {"powerstate": "on", "targetAddress": 50}] sample:
[
{
"powerstate": "on",
"targetAddress": 48
},
{
"powerstate": "on",
"targetAddress": 50
}
]
""" """
EXAMPLES = r""" EXAMPLES = r"""

9
plugins/modules/iptables_state.py
View file

@ -147,7 +147,8 @@ initial_state:
type: list type: list
elements: str elements: str
returned: always returned: always
sample: [ sample:
[
"# Generated by xtables-save v1.8.2", "# Generated by xtables-save v1.8.2",
"*filter", "*filter",
":INPUT ACCEPT [0:0]", ":INPUT ACCEPT [0:0]",
@ -161,7 +162,8 @@ restored:
type: list type: list
elements: str elements: str
returned: always returned: always
sample: [ sample:
[
"# Generated by xtables-save v1.8.2", "# Generated by xtables-save v1.8.2",
"*filter", "*filter",
":INPUT DROP [0:0]", ":INPUT DROP [0:0]",
@ -180,7 +182,8 @@ saved:
type: list type: list
elements: str elements: str
returned: always returned: always
sample: [ sample:
[
"# Generated by xtables-save v1.8.2", "# Generated by xtables-save v1.8.2",
"*filter", "*filter",
":INPUT ACCEPT [0:0]", ":INPUT ACCEPT [0:0]",

20
plugins/modules/irc.py
View file

@ -51,8 +51,24 @@ options:
description: description:
- Text color for the message. - Text color for the message.
default: "none" default: "none"
choices: ["none", "white", "black", "blue", "green", "red", "brown", "purple", "orange", "yellow", "light_green", "teal", choices:
"light_cyan", "light_blue", "pink", "gray", "light_gray"] - none
- white
- black
- blue
- green
- red
- brown
- purple
- orange
- yellow
- light_green
- teal
- light_cyan
- light_blue
- pink
- gray
- light_gray
aliases: [colour] aliases: [colour]
channel: channel:
type: str type: str

2
plugins/modules/jenkins_job_info.py
View file

@ -135,7 +135,7 @@ jobs:
"fullname": "test-folder/test-job", "fullname": "test-folder/test-job",
"url": "http://localhost:8080/job/test-job/", "url": "http://localhost:8080/job/test-job/",
"color": "blue" "color": "blue"
}, }
] ]
""" """

19
plugins/modules/keycloak_authentication.py
View file

@ -190,17 +190,20 @@ msg:
type: str type: str
end_state: end_state:
description: Representation of the authentication after module execution. description: Representation of the authentication after module execution.
returned: on success returned: on success
type: dict type: dict
sample: { sample:
{
"alias": "Copy of first broker login", "alias": "Copy of first broker login",
"authenticationExecutions": [ "authenticationExecutions": [
{ {
"alias": "review profile config", "alias": "review profile config",
"authenticationConfig": { "authenticationConfig": {
"alias": "review profile config", "alias": "review profile config",
"config": { "update.profile.on.first.login": "missing" }, "config": {
"update.profile.on.first.login": "missing"
},
"id": "6f09e4fb-aad4-496a-b873-7fa9779df6d7" "id": "6f09e4fb-aad4-496a-b873-7fa9779df6d7"
}, },
"configurable": true, "configurable": true,
@ -210,7 +213,11 @@ end_state:
"level": 0, "level": 0,
"providerId": "idp-review-profile", "providerId": "idp-review-profile",
"requirement": "REQUIRED", "requirement": "REQUIRED",
"requirementChoices": [ "REQUIRED", "ALTERNATIVE", "DISABLED" ] "requirementChoices": [
"REQUIRED",
"ALTERNATIVE",
"DISABLED"
]
} }
], ],
"builtIn": false, "builtIn": false,

11
plugins/modules/keycloak_client_rolescope.py
View file

@ -126,11 +126,12 @@ msg:
sample: "Client role scope for frontend-client-public has been updated" sample: "Client role scope for frontend-client-public has been updated"
end_state: end_state:
description: Representation of role role scope after module execution. description: Representation of role role scope after module execution.
returned: on success returned: on success
type: list type: list
elements: dict elements: dict
sample: [ sample:
[
{ {
"clientRole": false, "clientRole": false,
"composite": false, "composite": false,

25
plugins/modules/keycloak_clienttemplate.py
View file

@ -238,21 +238,36 @@ proposed:
description: Representation of proposed client template. description: Representation of proposed client template.
returned: always returned: always
type: dict type: dict
sample: {name: "test01"} sample:
{
"name": "test01"
}
existing: existing:
description: Representation of existing client template (sample is truncated). description: Representation of existing client template (sample is truncated).
returned: always returned: always
type: dict type: dict
sample: {"description": "test01", "fullScopeAllowed": false, "id": "9c3712ab-decd-481e-954f-76da7b006e5f", "name": "test01", sample:
"protocol": "saml"} {
"description": "test01",
"fullScopeAllowed": false,
"id": "9c3712ab-decd-481e-954f-76da7b006e5f",
"name": "test01",
"protocol": "saml"
}
end_state: end_state:
description: Representation of client template after module execution (sample is truncated). description: Representation of client template after module execution (sample is truncated).
returned: on success returned: on success
type: dict type: dict
sample: {"description": "test01", "fullScopeAllowed": false, "id": "9c3712ab-decd-481e-954f-76da7b006e5f", "name": "test01", sample:
"protocol": "saml"} {
"description": "test01",
"fullScopeAllowed": false,
"id": "9c3712ab-decd-481e-954f-76da7b006e5f",
"name": "test01",
"protocol": "saml"
}
""" """
from ansible_collections.community.general.plugins.module_utils.identity.keycloak.keycloak import KeycloakAPI, camel, \ from ansible_collections.community.general.plugins.module_utils.identity.keycloak.keycloak import KeycloakAPI, camel, \

131
plugins/modules/keycloak_identity_provider.py
View file

@ -354,76 +354,79 @@ msg:
sample: "Identity provider my-idp has been created" sample: "Identity provider my-idp has been created"
proposed: proposed:
description: Representation of proposed identity provider. description: Representation of proposed identity provider.
returned: always returned: always
type: dict type: dict
sample: { sample:
"config": { {
"authorizationUrl": "https://idp.example.com/auth", "config": {
"clientAuthMethod": "client_secret_post", "authorizationUrl": "https://idp.example.com/auth",
"clientId": "my-client", "clientAuthMethod": "client_secret_post",
"clientSecret": "secret", "clientId": "my-client",
"issuer": "https://idp.example.com", "clientSecret": "secret",
"tokenUrl": "https://idp.example.com/token", "issuer": "https://idp.example.com",
"userInfoUrl": "https://idp.example.com/userinfo" "tokenUrl": "https://idp.example.com/token",
}, "userInfoUrl": "https://idp.example.com/userinfo"
"displayName": "OpenID Connect IdP", },
"providerId": "oidc" "displayName": "OpenID Connect IdP",
"providerId": "oidc"
} }
existing: existing:
description: Representation of existing identity provider. description: Representation of existing identity provider.
returned: always returned: always
type: dict type: dict
sample: { sample:
"addReadTokenRoleOnCreate": false, {
"alias": "my-idp", "addReadTokenRoleOnCreate": false,
"authenticateByDefault": false, "alias": "my-idp",
"config": { "authenticateByDefault": false,
"authorizationUrl": "https://old.example.com/auth", "config": {
"clientAuthMethod": "client_secret_post", "authorizationUrl": "https://old.example.com/auth",
"clientId": "my-client", "clientAuthMethod": "client_secret_post",
"clientSecret": "**********", "clientId": "my-client",
"issuer": "https://old.example.com", "clientSecret": "**********",
"syncMode": "FORCE", "issuer": "https://old.example.com",
"tokenUrl": "https://old.example.com/token", "syncMode": "FORCE",
"userInfoUrl": "https://old.example.com/userinfo" "tokenUrl": "https://old.example.com/token",
}, "userInfoUrl": "https://old.example.com/userinfo"
"displayName": "OpenID Connect IdP", },
"enabled": true, "displayName": "OpenID Connect IdP",
"firstBrokerLoginFlowAlias": "first broker login", "enabled": true,
"internalId": "4d28d7e3-1b80-45bb-8a30-5822bf55aa1c", "firstBrokerLoginFlowAlias": "first broker login",
"linkOnly": false, "internalId": "4d28d7e3-1b80-45bb-8a30-5822bf55aa1c",
"providerId": "oidc", "linkOnly": false,
"storeToken": false, "providerId": "oidc",
"trustEmail": false, "storeToken": false,
"trustEmail": false
} }
end_state: end_state:
description: Representation of identity provider after module execution. description: Representation of identity provider after module execution.
returned: on success returned: on success
type: dict type: dict
sample: { sample:
"addReadTokenRoleOnCreate": false, {
"alias": "my-idp", "addReadTokenRoleOnCreate": false,
"authenticateByDefault": false, "alias": "my-idp",
"config": { "authenticateByDefault": false,
"authorizationUrl": "https://idp.example.com/auth", "config": {
"clientAuthMethod": "client_secret_post", "authorizationUrl": "https://idp.example.com/auth",
"clientId": "my-client", "clientAuthMethod": "client_secret_post",
"clientSecret": "**********", "clientId": "my-client",
"issuer": "https://idp.example.com", "clientSecret": "**********",
"tokenUrl": "https://idp.example.com/token", "issuer": "https://idp.example.com",
"userInfoUrl": "https://idp.example.com/userinfo" "tokenUrl": "https://idp.example.com/token",
}, "userInfoUrl": "https://idp.example.com/userinfo"
"displayName": "OpenID Connect IdP", },
"enabled": true, "displayName": "OpenID Connect IdP",
"firstBrokerLoginFlowAlias": "first broker login", "enabled": true,
"internalId": "4d28d7e3-1b80-45bb-8a30-5822bf55aa1c", "firstBrokerLoginFlowAlias": "first broker login",
"linkOnly": false, "internalId": "4d28d7e3-1b80-45bb-8a30-5822bf55aa1c",
"providerId": "oidc", "linkOnly": false,
"storeToken": false, "providerId": "oidc",
"trustEmail": false, "storeToken": false,
"trustEmail": false
} }
""" """

29
plugins/modules/keycloak_role.py
View file

@ -195,21 +195,40 @@ proposed:
description: Representation of proposed role. description: Representation of proposed role.
returned: always returned: always
type: dict type: dict
sample: {"description": "My updated test description"} sample:
{
"description": "My updated test description"
}
existing: existing:
description: Representation of existing role. description: Representation of existing role.
returned: always returned: always
type: dict type: dict
sample: {"attributes": {}, "clientRole": true, "composite": false, "containerId": "9f03eb61-a826-4771-a9fd-930e06d2d36a", sample:
"description": "My client test role", "id": "561703dd-0f38-45ff-9a5a-0c978f794547", "name": "myrole"} {
"attributes": {},
"clientRole": true,
"composite": false,
"containerId": "9f03eb61-a826-4771-a9fd-930e06d2d36a",
"description": "My client test role",
"id": "561703dd-0f38-45ff-9a5a-0c978f794547",
"name": "myrole"
}
end_state: end_state:
description: Representation of role after module execution (sample is truncated). description: Representation of role after module execution (sample is truncated).
returned: on success returned: on success
type: dict type: dict
sample: {"attributes": {}, "clientRole": true, "composite": false, "containerId": "9f03eb61-a826-4771-a9fd-930e06d2d36a", sample:
"description": "My updated client test role", "id": "561703dd-0f38-45ff-9a5a-0c978f794547", "name": "myrole"} {
"attributes": {},
"clientRole": true,
"composite": false,
"containerId": "9f03eb61-a826-4771-a9fd-930e06d2d36a",
"description": "My updated client test role",
"id": "561703dd-0f38-45ff-9a5a-0c978f794547",
"name": "myrole"
}
""" """
from ansible_collections.community.general.plugins.module_utils.identity.keycloak.keycloak import KeycloakAPI, camel, \ from ansible_collections.community.general.plugins.module_utils.identity.keycloak.keycloak import KeycloakAPI, camel, \

223
plugins/modules/keycloak_user_federation.py
View file

@ -598,122 +598,125 @@ msg:
sample: "No changes required to user federation 164bb483-c613-482e-80fe-7f1431308799." sample: "No changes required to user federation 164bb483-c613-482e-80fe-7f1431308799."
proposed: proposed:
description: Representation of proposed user federation. description: Representation of proposed user federation.
returned: always returned: always
type: dict type: dict
sample: { sample:
"config": { {
"allowKerberosAuthentication": "false", "config": {
"authType": "simple", "allowKerberosAuthentication": "false",
"batchSizeForSync": "1000", "authType": "simple",
"bindCredential": "**********", "batchSizeForSync": "1000",
"bindDn": "cn=directory reader", "bindCredential": "**********",
"cachePolicy": "DEFAULT", "bindDn": "cn=directory reader",
"connectionPooling": "true", "cachePolicy": "DEFAULT",
"connectionUrl": "ldaps://ldap.example.com:636", "connectionPooling": "true",
"debug": "false", "connectionUrl": "ldaps://ldap.example.com:636",
"editMode": "READ_ONLY", "debug": "false",
"enabled": "true", "editMode": "READ_ONLY",
"importEnabled": "true", "enabled": "true",
"pagination": "true", "importEnabled": "true",
"priority": "0", "pagination": "true",
"rdnLDAPAttribute": "uid", "priority": "0",
"searchScope": "1", "rdnLDAPAttribute": "uid",
"syncRegistrations": "false", "searchScope": "1",
"trustEmail": "false", "syncRegistrations": "false",
"useKerberosForPasswordAuthentication": "false", "trustEmail": "false",
"useTruststoreSpi": "ldapsOnly", "useKerberosForPasswordAuthentication": "false",
"userObjectClasses": "inetOrgPerson, organizationalPerson", "useTruststoreSpi": "ldapsOnly",
"usernameLDAPAttribute": "uid", "userObjectClasses": "inetOrgPerson, organizationalPerson",
"usersDn": "ou=Users,dc=example,dc=com", "usernameLDAPAttribute": "uid",
"uuidLDAPAttribute": "entryUUID", "usersDn": "ou=Users,dc=example,dc=com",
"validatePasswordPolicy": "false", "uuidLDAPAttribute": "entryUUID",
"vendor": "other" "validatePasswordPolicy": "false",
}, "vendor": "other"
"name": "ldap", },
"providerId": "ldap", "name": "ldap",
"providerType": "org.keycloak.storage.UserStorageProvider" "providerId": "ldap",
"providerType": "org.keycloak.storage.UserStorageProvider"
} }
existing: existing:
description: Representation of existing user federation. description: Representation of existing user federation.
returned: always returned: always
type: dict type: dict
sample: { sample:
"config": { {
"allowKerberosAuthentication": "false", "config": {
"authType": "simple", "allowKerberosAuthentication": "false",
"batchSizeForSync": "1000", "authType": "simple",
"bindCredential": "**********", "batchSizeForSync": "1000",
"bindDn": "cn=directory reader", "bindCredential": "**********",
"cachePolicy": "DEFAULT", "bindDn": "cn=directory reader",
"changedSyncPeriod": "-1", "cachePolicy": "DEFAULT",
"connectionPooling": "true", "changedSyncPeriod": "-1",
"connectionUrl": "ldaps://ldap.example.com:636", "connectionPooling": "true",
"debug": "false", "connectionUrl": "ldaps://ldap.example.com:636",
"editMode": "READ_ONLY", "debug": "false",
"enabled": "true", "editMode": "READ_ONLY",
"fullSyncPeriod": "-1", "enabled": "true",
"importEnabled": "true", "fullSyncPeriod": "-1",
"pagination": "true", "importEnabled": "true",
"priority": "0", "pagination": "true",
"rdnLDAPAttribute": "uid", "priority": "0",
"searchScope": "1", "rdnLDAPAttribute": "uid",
"syncRegistrations": "false", "searchScope": "1",
"trustEmail": "false", "syncRegistrations": "false",
"useKerberosForPasswordAuthentication": "false", "trustEmail": "false",
"useTruststoreSpi": "ldapsOnly", "useKerberosForPasswordAuthentication": "false",
"userObjectClasses": "inetOrgPerson, organizationalPerson", "useTruststoreSpi": "ldapsOnly",
"usernameLDAPAttribute": "uid", "userObjectClasses": "inetOrgPerson, organizationalPerson",
"usersDn": "ou=Users,dc=example,dc=com", "usernameLDAPAttribute": "uid",
"uuidLDAPAttribute": "entryUUID", "usersDn": "ou=Users,dc=example,dc=com",
"validatePasswordPolicy": "false", "uuidLDAPAttribute": "entryUUID",
"vendor": "other" "validatePasswordPolicy": "false",
}, "vendor": "other"
"id": "01122837-9047-4ae4-8ca0-6e2e891a765f", },
"mappers": [ "id": "01122837-9047-4ae4-8ca0-6e2e891a765f",
{ "mappers": [
"config": { {
"always.read.value.from.ldap": "false", "config": {
"is.mandatory.in.ldap": "false", "always.read.value.from.ldap": "false",
"ldap.attribute": "mail", "is.mandatory.in.ldap": "false",
"read.only": "true", "ldap.attribute": "mail",
"user.model.attribute": "email" "read.only": "true",
}, "user.model.attribute": "email"
"id": "17d60ce2-2d44-4c2c-8b1f-1fba601b9a9f", },
"name": "email", "id": "17d60ce2-2d44-4c2c-8b1f-1fba601b9a9f",
"parentId": "01122837-9047-4ae4-8ca0-6e2e891a765f", "name": "email",
"providerId": "user-attribute-ldap-mapper", "parentId": "01122837-9047-4ae4-8ca0-6e2e891a765f",
"providerType": "org.keycloak.storage.ldap.mappers.LDAPStorageMapper" "providerId": "user-attribute-ldap-mapper",
} "providerType": "org.keycloak.storage.ldap.mappers.LDAPStorageMapper"
], }
"name": "myfed", ],
"parentId": "myrealm", "name": "myfed",
"providerId": "ldap", "parentId": "myrealm",
"providerType": "org.keycloak.storage.UserStorageProvider" "providerId": "ldap",
"providerType": "org.keycloak.storage.UserStorageProvider"
} }
end_state: end_state:
description: Representation of user federation after module execution. description: Representation of user federation after module execution.
returned: on success returned: on success
type: dict type: dict
sample: { sample:
"config": { {
"allowPasswordAuthentication": "false", "config": {
"cachePolicy": "DEFAULT", "allowPasswordAuthentication": "false",
"enabled": "true", "cachePolicy": "DEFAULT",
"kerberosRealm": "EXAMPLE.COM", "enabled": "true",
"keyTab": "/etc/krb5.keytab", "kerberosRealm": "EXAMPLE.COM",
"priority": "0", "keyTab": "/etc/krb5.keytab",
"serverPrincipal": "HTTP/host.example.com@EXAMPLE.COM", "priority": "0",
"updateProfileFirstLogin": "false" "serverPrincipal": "HTTP/host.example.com@EXAMPLE.COM",
}, "updateProfileFirstLogin": "false"
"id": "cf52ae4f-4471-4435-a0cf-bb620cadc122", },
"mappers": [], "id": "cf52ae4f-4471-4435-a0cf-bb620cadc122",
"name": "kerberos", "mappers": [],
"parentId": "myrealm", "name": "kerberos",
"providerId": "kerberos", "parentId": "myrealm",
"providerType": "org.keycloak.storage.UserStorageProvider" "providerId": "kerberos",
"providerType": "org.keycloak.storage.UserStorageProvider"
} }
""" """

20
plugins/modules/launchd.py
View file

@ -111,16 +111,16 @@ EXAMPLES = r"""
RETURN = r""" RETURN = r"""
status: status:
description: Metadata about service status. description: Metadata about service status.
returned: always returned: always
type: dict type: dict
sample: sample:
{ {
"current_pid": "-", "current_pid": "-",
"current_state": "stopped", "current_state": "stopped",
"previous_pid": "82636", "previous_pid": "82636",
"previous_state": "running" "previous_state": "running"
} }
""" """
import os import os

2
plugins/modules/logentries_msg.py
View file

@ -45,7 +45,7 @@ options:
author: "Jimmy Tang (@jcftang) <jimmy_tang@rapid7.com>" author: "Jimmy Tang (@jcftang) <jimmy_tang@rapid7.com>"
""" """
RETURN = """# """ RETURN = """#"""
EXAMPLES = r""" EXAMPLES = r"""
- name: Send a message to logentries - name: Send a message to logentries

15
plugins/modules/lvm_pv.py
View file

@ -9,8 +9,7 @@ from __future__ import absolute_import, division, print_function
__metaclass__ = type __metaclass__ = type
DOCUMENTATION = r''' DOCUMENTATION = r"""
---
module: lvm_pv module: lvm_pv
short_description: Manage LVM Physical Volumes short_description: Manage LVM Physical Volumes
version_added: "11.0.0" version_added: "11.0.0"
@ -28,7 +27,7 @@ options:
description: description:
- Control if the physical volume exists. - Control if the physical volume exists.
type: str type: str
choices: [ present, absent ] choices: [present, absent]
default: present default: present
force: force:
description: description:
@ -45,9 +44,9 @@ options:
notes: notes:
- Requires LVM2 utilities installed on the target system. - Requires LVM2 utilities installed on the target system.
- Device path must exist when creating a PV. - Device path must exist when creating a PV.
''' """
EXAMPLES = r''' EXAMPLES = r"""
- name: Creating physical volume on /dev/sdb - name: Creating physical volume on /dev/sdb
community.general.lvm_pv: community.general.lvm_pv:
device: /dev/sdb device: /dev/sdb
@ -67,10 +66,10 @@ EXAMPLES = r'''
device: /dev/sdb device: /dev/sdb
force: true force: true
state: absent state: absent
''' """
RETURN = r''' RETURN = r"""
''' """
import os import os

72
plugins/modules/manageiq_policies.py
View file

@ -45,8 +45,21 @@ options:
description: description:
- The type of the resource to which the profile should be [un]assigned. - The type of the resource to which the profile should be [un]assigned.
required: true required: true
choices: ['provider', 'host', 'vm', 'blueprint', 'category', 'cluster', 'data store', 'group', 'resource pool', 'service', choices:
'service template', 'template', 'tenant', 'user'] - provider
- host
- vm
- blueprint
- category
- cluster
- data store
- group
- resource pool
- service
- service template
- template
- tenant
- user
resource_name: resource_name:
type: str type: str
description: description:
@ -89,35 +102,36 @@ EXAMPLES = r"""
RETURN = r""" RETURN = r"""
manageiq_policies: manageiq_policies:
description: description:
- List current policy_profile and policies for a provider in ManageIQ. - List current policy_profile and policies for a provider in ManageIQ.
returned: always returned: always
type: dict type: dict
sample: { sample:
"changed": false, {
"profiles": [ "changed": false,
"profiles": [
{
"policies": [
{ {
"policies": [ "active": true,
{ "description": "OpenSCAP",
"active": true, "name": "openscap policy"
"description": "OpenSCAP", },
"name": "openscap policy" {
}, "active": true,
{ "description": "Analyse incoming container images",
"active": true, "name": "analyse incoming container images"
"description": "Analyse incoming container images", },
"name": "analyse incoming container images" {
}, "active": true,
{ "description": "Schedule compliance after smart state analysis",
"active": true, "name": "schedule compliance after smart state analysis"
"description": "Schedule compliance after smart state analysis",
"name": "schedule compliance after smart state analysis"
}
],
"profile_description": "OpenSCAP profile",
"profile_name": "openscap profile"
} }
] ],
"profile_description": "OpenSCAP profile",
"profile_name": "openscap profile"
}
]
} }
""" """

17
plugins/modules/manageiq_policies_info.py
View file

@ -29,8 +29,21 @@ options:
description: description:
- The type of the resource to obtain the profile for. - The type of the resource to obtain the profile for.
required: true required: true
choices: ['provider', 'host', 'vm', 'blueprint', 'category', 'cluster', 'data store', 'group', 'resource pool', 'service', choices:
'service template', 'template', 'tenant', 'user'] - provider
- host
- vm
- blueprint
- category
- cluster
- data store
- group
- resource pool
- service
- service template
- template
- tenant
- user
resource_name: resource_name:
type: str type: str
description: description:

17
plugins/modules/manageiq_tags.py
View file

@ -45,8 +45,21 @@ options:
description: description:
- The relevant resource type in manageiq. - The relevant resource type in manageiq.
required: true required: true
choices: ['provider', 'host', 'vm', 'blueprint', 'category', 'cluster', 'data store', 'group', 'resource pool', 'service', choices:
'service template', 'template', 'tenant', 'user'] - provider
- host
- vm
- blueprint
- category
- cluster
- data store
- group
- resource pool
- service
- service template
- template
- tenant
- user
resource_name: resource_name:
type: str type: str
description: description:

17
plugins/modules/manageiq_tags_info.py
View file

@ -27,8 +27,21 @@ options:
description: description:
- The relevant resource type in ManageIQ. - The relevant resource type in ManageIQ.
required: true required: true
choices: ['provider', 'host', 'vm', 'blueprint', 'category', 'cluster', 'data store', 'group', 'resource pool', 'service', choices:
'service template', 'template', 'tenant', 'user'] - provider
- host
- vm
- blueprint
- category
- cluster
- data store
- group
- resource pool
- service
- service template
- template
- tenant
- user
resource_name: resource_name:
type: str type: str
description: description:

78
plugins/modules/memset_server_info.py
View file

@ -74,31 +74,32 @@ memset_api:
description: Details about the firewall group this server is in. description: Details about the firewall group this server is in.
returned: always returned: always
type: dict type: dict
sample: { sample:
"default_outbound_policy": "RETURN", {
"name": "testyaa-fw1", "default_outbound_policy": "RETURN",
"nickname": "testyaa cPanel rules", "name": "testyaa-fw1",
"notes": "", "nickname": "testyaa cPanel rules",
"public": false, "notes": "",
"rules": { "public": false,
"51d7db54d39c3544ef7c48baa0b9944f": { "rules": {
"action": "ACCEPT", "51d7db54d39c3544ef7c48baa0b9944f": {
"comment": "", "action": "ACCEPT",
"dest_ip6s": "any", "comment": "",
"dest_ips": "any", "dest_ip6s": "any",
"dest_ports": "any", "dest_ips": "any",
"direction": "Inbound", "dest_ports": "any",
"ip_version": "any", "direction": "Inbound",
"ordering": 2, "ip_version": "any",
"protocols": "icmp", "ordering": 2,
"rule_group_name": "testyaa-fw1", "protocols": "icmp",
"rule_id": "51d7db54d39c3544ef7c48baa0b9944f", "rule_group_name": "testyaa-fw1",
"source_ip6s": "any", "rule_id": "51d7db54d39c3544ef7c48baa0b9944f",
"source_ips": "any", "source_ip6s": "any",
"source_ports": "any" "source_ips": "any",
"source_ports": "any"
}
} }
} }
}
firewall_type: firewall_type:
description: The type of firewall the server has (for example self-managed, managed). description: The type of firewall the server has (for example self-managed, managed).
returned: always returned: always
@ -118,15 +119,16 @@ memset_api:
description: List of dictionaries of all IP addresses assigned to the server. description: List of dictionaries of all IP addresses assigned to the server.
returned: always returned: always
type: list type: list
sample: [ sample:
{ [
"address": "1.2.3.4", {
"bytes_in_today": 1000.0, "address": "1.2.3.4",
"bytes_in_yesterday": 2000.0, "bytes_in_today": 1000.0,
"bytes_out_today": 1000.0, "bytes_in_yesterday": 2000.0,
"bytes_out_yesterday": 2000.0 "bytes_out_today": 1000.0,
} "bytes_out_yesterday": 2000.0
] }
]
monitor: monitor:
description: Whether the server has monitoring enabled. description: Whether the server has monitoring enabled.
returned: always returned: always
@ -221,10 +223,14 @@ memset_api:
description: Dictionary of tagged and untagged VLANs this server is in. description: Dictionary of tagged and untagged VLANs this server is in.
returned: always returned: always
type: dict type: dict
sample: { sample:
tagged: [], {
untagged: [ 'testyaa-vlan1', 'testyaa-vlan2' ] "tagged": [],
} "untagged": [
"testyaa-vlan1",
"testyaa-vlan2"
]
}
vulnscan: vulnscan:
description: Vulnerability scanning level. description: Vulnerability scanning level.
returned: always returned: always

16
plugins/modules/nagios.py
View file

@ -40,8 +40,20 @@ options:
- Action to take. - Action to take.
- The V(acknowledge) and V(forced_check) actions were added in community.general 1.2.0. - The V(acknowledge) and V(forced_check) actions were added in community.general 1.2.0.
required: true required: true
choices: ["downtime", "delete_downtime", "enable_alerts", "disable_alerts", "silence", "unsilence", "silence_nagios", choices:
"unsilence_nagios", "command", "servicegroup_service_downtime", "servicegroup_host_downtime", "acknowledge", "forced_check"] - downtime
- delete_downtime
- enable_alerts
- disable_alerts
- silence
- unsilence
- silence_nagios
- unsilence_nagios
- command
- servicegroup_service_downtime
- servicegroup_host_downtime
- acknowledge
- forced_check
type: str type: str
host: host:
description: description:

28
plugins/modules/nmcli.py
View file

@ -95,8 +95,32 @@ options:
- If you want to control non-ethernet connection attached to V(bond), V(bridge), or V(team) consider using O(slave_type) - If you want to control non-ethernet connection attached to V(bond), V(bridge), or V(team) consider using O(slave_type)
option. option.
type: str type: str
choices: [bond, bond-slave, bridge, bridge-slave, dummy, ethernet, generic, gre, infiniband, ipip, macvlan, sit, team, choices:
team-slave, vlan, vxlan, wifi, gsm, wireguard, ovs-bridge, ovs-port, ovs-interface, vpn, vrf, loopback] - bond
- bond-slave
- bridge
- bridge-slave
- dummy
- ethernet
- generic
- gre
- infiniband
- ipip
- macvlan
- sit
- team
- team-slave
- vlan
- vxlan
- wifi
- gsm
- wireguard
- ovs-bridge
- ovs-port
- ovs-interface
- vpn
- vrf
- loopback
mode: mode:
description: description:
- This is the type of device or network connection that you wish to create for a bond or bridge. - This is the type of device or network connection that you wish to create for a bond or bridge.

418
plugins/modules/nomad_job_info.py
View file

@ -49,219 +49,219 @@ EXAMPLES = r"""
RETURN = r""" RETURN = r"""
result: result:
description: List with dictionary contains jobs info description: List with dictionary contains jobs info.
returned: success returned: success
type: list type: list
sample: [ sample:
{ [
{
"Affinities": null,
"AllAtOnce": false,
"Constraints": null,
"ConsulToken": "",
"CreateIndex": 13,
"Datacenters": [
"dc1"
],
"Dispatched": false,
"ID": "example",
"JobModifyIndex": 13,
"Meta": null,
"ModifyIndex": 13,
"Multiregion": null,
"Name": "example",
"Namespace": "default",
"NomadTokenID": "",
"ParameterizedJob": null,
"ParentID": "",
"Payload": null,
"Periodic": null,
"Priority": 50,
"Region": "global",
"Spreads": null,
"Stable": false,
"Status": "pending",
"StatusDescription": "",
"Stop": false,
"SubmitTime": 1602244370615307000,
"TaskGroups": [
{
"Affinities": null, "Affinities": null,
"AllAtOnce": false,
"Constraints": null, "Constraints": null,
"ConsulToken": "", "Count": 1,
"CreateIndex": 13, "EphemeralDisk": {
"Datacenters": [ "Migrate": false,
"dc1" "SizeMB": 300,
], "Sticky": false
"Dispatched": false,
"ID": "example",
"JobModifyIndex": 13,
"Meta": null,
"ModifyIndex": 13,
"Multiregion": null,
"Name": "example",
"Namespace": "default",
"NomadTokenID": "",
"ParameterizedJob": null,
"ParentID": "",
"Payload": null,
"Periodic": null,
"Priority": 50,
"Region": "global",
"Spreads": null,
"Stable": false,
"Status": "pending",
"StatusDescription": "",
"Stop": false,
"SubmitTime": 1602244370615307000,
"TaskGroups": [
{
"Affinities": null,
"Constraints": null,
"Count": 1,
"EphemeralDisk": {
"Migrate": false,
"SizeMB": 300,
"Sticky": false
},
"Meta": null,
"Migrate": {
"HealthCheck": "checks",
"HealthyDeadline": 300000000000,
"MaxParallel": 1,
"MinHealthyTime": 10000000000
},
"Name": "cache",
"Networks": null,
"ReschedulePolicy": {
"Attempts": 0,
"Delay": 30000000000,
"DelayFunction": "exponential",
"Interval": 0,
"MaxDelay": 3600000000000,
"Unlimited": true
},
"RestartPolicy": {
"Attempts": 3,
"Delay": 15000000000,
"Interval": 1800000000000,
"Mode": "fail"
},
"Scaling": null,
"Services": null,
"ShutdownDelay": null,
"Spreads": null,
"StopAfterClientDisconnect": null,
"Tasks": [
{
"Affinities": null,
"Artifacts": null,
"CSIPluginConfig": null,
"Config": {
"image": "redis:3.2",
"port_map": [
{
"db": 6379.0
}
]
},
"Constraints": null,
"DispatchPayload": null,
"Driver": "docker",
"Env": null,
"KillSignal": "",
"KillTimeout": 5000000000,
"Kind": "",
"Leader": false,
"Lifecycle": null,
"LogConfig": {
"MaxFileSizeMB": 10,
"MaxFiles": 10
},
"Meta": null,
"Name": "redis",
"Resources": {
"CPU": 500,
"Devices": null,
"DiskMB": 0,
"IOPS": 0,
"MemoryMB": 256,
"Networks": [
{
"CIDR": "",
"DNS": null,
"Device": "",
"DynamicPorts": [
{
"HostNetwork": "default",
"Label": "db",
"To": 0,
"Value": 0
}
],
"IP": "",
"MBits": 10,
"Mode": "",
"ReservedPorts": null
}
]
},
"RestartPolicy": {
"Attempts": 3,
"Delay": 15000000000,
"Interval": 1800000000000,
"Mode": "fail"
},
"Services": [
{
"AddressMode": "auto",
"CanaryMeta": null,
"CanaryTags": null,
"Checks": [
{
"AddressMode": "",
"Args": null,
"CheckRestart": null,
"Command": "",
"Expose": false,
"FailuresBeforeCritical": 0,
"GRPCService": "",
"GRPCUseTLS": false,
"Header": null,
"InitialStatus": "",
"Interval": 10000000000,
"Method": "",
"Name": "alive",
"Path": "",
"PortLabel": "",
"Protocol": "",
"SuccessBeforePassing": 0,
"TLSSkipVerify": false,
"TaskName": "",
"Timeout": 2000000000,
"Type": "tcp"
}
],
"Connect": null,
"EnableTagOverride": false,
"Meta": null,
"Name": "redis-cache",
"PortLabel": "db",
"Tags": [
"global",
"cache"
],
"TaskName": ""
}
],
"ShutdownDelay": 0,
"Templates": null,
"User": "",
"Vault": null,
"VolumeMounts": null
}
],
"Update": {
"AutoPromote": false,
"AutoRevert": false,
"Canary": 0,
"HealthCheck": "checks",
"HealthyDeadline": 180000000000,
"MaxParallel": 1,
"MinHealthyTime": 10000000000,
"ProgressDeadline": 600000000000,
"Stagger": 30000000000
},
"Volumes": null
}
],
"Type": "service",
"Update": {
"AutoPromote": false,
"AutoRevert": false,
"Canary": 0,
"HealthCheck": "",
"HealthyDeadline": 0,
"MaxParallel": 1,
"MinHealthyTime": 0,
"ProgressDeadline": 0,
"Stagger": 30000000000
}, },
"VaultNamespace": "", "Meta": null,
"VaultToken": "", "Migrate": {
"Version": 0 "HealthCheck": "checks",
} "HealthyDeadline": 300000000000,
"MaxParallel": 1,
"MinHealthyTime": 10000000000
},
"Name": "cache",
"Networks": null,
"ReschedulePolicy": {
"Attempts": 0,
"Delay": 30000000000,
"DelayFunction": "exponential",
"Interval": 0,
"MaxDelay": 3600000000000,
"Unlimited": true
},
"RestartPolicy": {
"Attempts": 3,
"Delay": 15000000000,
"Interval": 1800000000000,
"Mode": "fail"
},
"Scaling": null,
"Services": null,
"ShutdownDelay": null,
"Spreads": null,
"StopAfterClientDisconnect": null,
"Tasks": [
{
"Affinities": null,
"Artifacts": null,
"CSIPluginConfig": null,
"Config": {
"image": "redis:3.2",
"port_map": [
{
"db": 6379.0
}
]
},
"Constraints": null,
"DispatchPayload": null,
"Driver": "docker",
"Env": null,
"KillSignal": "",
"KillTimeout": 5000000000,
"Kind": "",
"Leader": false,
"Lifecycle": null,
"LogConfig": {
"MaxFileSizeMB": 10,
"MaxFiles": 10
},
"Meta": null,
"Name": "redis",
"Resources": {
"CPU": 500,
"Devices": null,
"DiskMB": 0,
"IOPS": 0,
"MemoryMB": 256,
"Networks": [
{
"CIDR": "",
"DNS": null,
"Device": "",
"DynamicPorts": [
{
"HostNetwork": "default",
"Label": "db",
"To": 0,
"Value": 0
}
],
"IP": "",
"MBits": 10,
"Mode": "",
"ReservedPorts": null
}
]
},
"RestartPolicy": {
"Attempts": 3,
"Delay": 15000000000,
"Interval": 1800000000000,
"Mode": "fail"
},
"Services": [
{
"AddressMode": "auto",
"CanaryMeta": null,
"CanaryTags": null,
"Checks": [
{
"AddressMode": "",
"Args": null,
"CheckRestart": null,
"Command": "",
"Expose": false,
"FailuresBeforeCritical": 0,
"GRPCService": "",
"GRPCUseTLS": false,
"Header": null,
"InitialStatus": "",
"Interval": 10000000000,
"Method": "",
"Name": "alive",
"Path": "",
"PortLabel": "",
"Protocol": "",
"SuccessBeforePassing": 0,
"TLSSkipVerify": false,
"TaskName": "",
"Timeout": 2000000000,
"Type": "tcp"
}
],
"Connect": null,
"EnableTagOverride": false,
"Meta": null,
"Name": "redis-cache",
"PortLabel": "db",
"Tags": [
"global",
"cache"
],
"TaskName": ""
}
],
"ShutdownDelay": 0,
"Templates": null,
"User": "",
"Vault": null,
"VolumeMounts": null
}
],
"Update": {
"AutoPromote": false,
"AutoRevert": false,
"Canary": 0,
"HealthCheck": "checks",
"HealthyDeadline": 180000000000,
"MaxParallel": 1,
"MinHealthyTime": 10000000000,
"ProgressDeadline": 600000000000,
"Stagger": 30000000000
},
"Volumes": null
}
],
"Type": "service",
"Update": {
"AutoPromote": false,
"AutoRevert": false,
"Canary": 0,
"HealthCheck": "",
"HealthyDeadline": 0,
"MaxParallel": 1,
"MinHealthyTime": 0,
"ProgressDeadline": 0,
"Stagger": 30000000000
},
"VaultNamespace": "",
"VaultToken": "",
"Version": 0
}
] ]
""" """
from ansible.module_utils.basic import AnsibleModule, missing_required_lib from ansible.module_utils.basic import AnsibleModule, missing_required_lib

39
plugins/modules/nomad_token.py
View file

@ -98,25 +98,26 @@ EXAMPLES = r"""
RETURN = r""" RETURN = r"""
result: result:
description: Result returned by nomad. description: Result returned by nomad.
returned: always returned: always
type: dict type: dict
sample: { sample:
"accessor_id": "0d01c55f-8d63-f832-04ff-1866d4eb594e", {
"create_index": 14, "accessor_id": "0d01c55f-8d63-f832-04ff-1866d4eb594e",
"create_time": "2023-11-12T18:48:34.248857001Z", "create_index": 14,
"expiration_time": null, "create_time": "2023-11-12T18:48:34.248857001Z",
"expiration_ttl": "", "expiration_time": null,
"global": true, "expiration_ttl": "",
"hash": "eSn8H8RVqh8As8WQNnC2vlBRqXy6DECogc5umzX0P30=", "global": true,
"modify_index": 836, "hash": "eSn8H8RVqh8As8WQNnC2vlBRqXy6DECogc5umzX0P30=",
"name": "devs", "modify_index": 836,
"policies": [ "name": "devs",
"readonly" "policies": [
], "readonly"
"roles": null, ],
"secret_id": "12e878ab-e1f6-e103-b4c4-3b5173bb4cea", "roles": null,
"type": "client" "secret_id": "12e878ab-e1f6-e103-b4c4-3b5173bb4cea",
"type": "client"
} }
""" """

37
plugins/modules/ocapi_info.py
View file

@ -120,24 +120,25 @@ details:
elements: str elements: str
status: status:
description: Dictionary containing status information. See OCAPI documentation for details. description: Dictionary containing status information. See OCAPI documentation for details.
returned: when supported returned: when supported
type: dict type: dict
sample: { sample:
"Details": [ {
"None" "Details": [
], "None"
"Health": [ ],
{ "Health": [
"ID": 5, {
"Name": "OK" "ID": 5,
} "Name": "OK"
], }
"State": { ],
"ID": 16, "State": {
"Name": "In service" "ID": 16,
} "Name": "In service"
} }
}
""" """
from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.basic import AnsibleModule

33
plugins/modules/oci_vcn.py
View file

@ -78,22 +78,23 @@ EXAMPLES = r"""
RETURN = r""" RETURN = r"""
vcn: vcn:
description: Information about the VCN description: Information about the VCN.
returned: On successful create and update operation returned: On successful create and update operation
type: dict type: dict
sample: { sample:
"cidr_block": "10.0.0.0/16", {
compartment_id": "ocid1.compartment.oc1..xxxxxEXAMPLExxxxx", "cidr_block": "10.0.0.0/16",
"default_dhcp_options_id": "ocid1.dhcpoptions.oc1.phx.xxxxxEXAMPLExxxxx", "compartment_id\"": "ocid1.compartment.oc1..xxxxxEXAMPLExxxxx",
"default_route_table_id": "ocid1.routetable.oc1.phx.xxxxxEXAMPLExxxxx", "default_dhcp_options_id": "ocid1.dhcpoptions.oc1.phx.xxxxxEXAMPLExxxxx",
"default_security_list_id": "ocid1.securitylist.oc1.phx.xxxxxEXAMPLExxxxx", "default_route_table_id": "ocid1.routetable.oc1.phx.xxxxxEXAMPLExxxxx",
"display_name": "ansible_vcn", "default_security_list_id": "ocid1.securitylist.oc1.phx.xxxxxEXAMPLExxxxx",
"dns_label": "ansiblevcn", "display_name": "ansible_vcn",
"id": "ocid1.vcn.oc1.phx.xxxxxEXAMPLExxxxx", "dns_label": "ansiblevcn",
"lifecycle_state": "AVAILABLE", "id": "ocid1.vcn.oc1.phx.xxxxxEXAMPLExxxxx",
"time_created": "2017-11-13T20:22:40.626000+00:00", "lifecycle_state": "AVAILABLE",
"vcn_domain_name": "ansiblevcn.oraclevcn.com" "time_created": "2017-11-13T20:22:40.626000+00:00",
} "vcn_domain_name": "ansiblevcn.oraclevcn.com"
}
""" """
from ansible.module_utils.basic import AnsibleModule, missing_required_lib from ansible.module_utils.basic import AnsibleModule, missing_required_lib

6
plugins/modules/oneandone_firewall_policy.py
View file

@ -144,7 +144,7 @@ EXAMPLES = r"""
firewall_policy: ansible-firewall-policy-updated firewall_policy: ansible-firewall-policy-updated
add_server_ips: add_server_ips:
- server_identifier (id or name) - server_identifier (id or name)
- server_identifier #2 (id or name) - "server_identifier #2 (id or name)"
wait: true wait: true
wait_timeout: 500 wait_timeout: 500
state: update state: update
@ -182,8 +182,8 @@ EXAMPLES = r"""
auth_token: oneandone_private_api_key auth_token: oneandone_private_api_key
firewall_policy: ansible-firewall-policy-updated firewall_policy: ansible-firewall-policy-updated
remove_rules: remove_rules:
- rule_id #1 - "rule_id #1"
- rule_id #2 - "rule_id #2"
- '...' - '...'
wait: true wait: true
wait_timeout: 500 wait_timeout: 500

4
plugins/modules/oneandone_load_balancer.py
View file

@ -233,8 +233,8 @@ EXAMPLES = r"""
load_balancer: ansible load balancer updated load_balancer: ansible load balancer updated
description: Adding rules to a load balancer with ansible description: Adding rules to a load balancer with ansible
remove_rules: remove_rules:
- rule_id #1 - "rule_id #1"
- rule_id #2 - "rule_id #2"
- '...' - '...'
wait: true wait: true
wait_timeout: 500 wait_timeout: 500

164
plugins/modules/online_server_info.py
View file

@ -42,91 +42,91 @@ online_server_info:
elements: dict elements: dict
sample: sample:
"online_server_info": [ "online_server_info": [
{ {
"abuse": "abuse@example.com", "abuse": "abuse@example.com",
"anti_ddos": false, "anti_ddos": false,
"bmc": { "bmc": {
"session_key": null "session_key": null
}, },
"boot_mode": "normal", "boot_mode": "normal",
"contacts": { "contacts": {
"owner": "foobar", "owner": "foobar",
"tech": "foobar" "tech": "foobar"
}, },
"disks": [
{
"$ref": "/api/v1/server/hardware/disk/68452"
},
{
"$ref": "/api/v1/server/hardware/disk/68453"
}
],
"drive_arrays": [
{
"disks": [ "disks": [
{ {
"$ref": "/api/v1/server/hardware/disk/68452" "$ref": "/api/v1/server/hardware/disk/68452"
}, },
{ {
"$ref": "/api/v1/server/hardware/disk/68453" "$ref": "/api/v1/server/hardware/disk/68453"
} }
], ],
"drive_arrays": [ "raid_controller": {
{ "$ref": "/api/v1/server/hardware/raidController/9910"
"disks": [
{
"$ref": "/api/v1/server/hardware/disk/68452"
},
{
"$ref": "/api/v1/server/hardware/disk/68453"
}
],
"raid_controller": {
"$ref": "/api/v1/server/hardware/raidController/9910"
},
"raid_level": "RAID1"
}
],
"hardware_watch": true,
"hostname": "sd-42",
"id": 42,
"ip": [
{
"address": "195.154.172.149",
"mac": "28:92:4a:33:5e:c6",
"reverse": "195-154-172-149.rev.poneytelecom.eu.",
"switch_port_state": "up",
"type": "public"
},
{
"address": "10.90.53.212",
"mac": "28:92:4a:33:5e:c7",
"reverse": null,
"switch_port_state": "up",
"type": "private"
}
],
"last_reboot": "2018-08-23T08:32:03.000Z",
"location": {
"block": "A",
"datacenter": "DC3",
"position": 19,
"rack": "A23",
"room": "4 4-4"
}, },
"network": { "raid_level": "RAID1"
"ip": [ }
"195.154.172.149" ],
], "hardware_watch": true,
"ipfo": [], "hostname": "sd-42",
"private": [ "id": 42,
"10.90.53.212" "ip": [
] {
}, "address": "195.154.172.149",
"offer": "Pro-1-S-SATA", "mac": "28:92:4a:33:5e:c6",
"os": { "reverse": "195-154-172-149.rev.poneytelecom.eu.",
"name": "FreeBSD", "switch_port_state": "up",
"version": "11.1-RELEASE" "type": "public"
}, },
"power": "ON", {
"proactive_monitoring": false, "address": "10.90.53.212",
"raid_controllers": [ "mac": "28:92:4a:33:5e:c7",
{ "reverse": null,
"$ref": "/api/v1/server/hardware/raidController/9910" "switch_port_state": "up",
} "type": "private"
], }
"support": "Basic service level" ],
} "last_reboot": "2018-08-23T08:32:03.000Z",
"location": {
"block": "A",
"datacenter": "DC3",
"position": 19,
"rack": "A23",
"room": "4 4-4"
},
"network": {
"ip": [
"195.154.172.149"
],
"ipfo": [],
"private": [
"10.90.53.212"
]
},
"offer": "Pro-1-S-SATA",
"os": {
"name": "FreeBSD",
"version": "11.1-RELEASE"
},
"power": "ON",
"proactive_monitoring": false,
"raid_controllers": [
{
"$ref": "/api/v1/server/hardware/raidController/9910"
}
],
"support": "Basic service level"
}
] ]
""" """

12
plugins/modules/online_user_info.py
View file

@ -38,12 +38,12 @@ online_user_info:
type: dict type: dict
sample: sample:
"online_user_info": { "online_user_info": {
"company": "foobar LLC", "company": "foobar LLC",
"email": "foobar@example.com", "email": "foobar@example.com",
"first_name": "foo", "first_name": "foo",
"id": 42, "id": 42,
"last_name": "bar", "last_name": "bar",
"login": "foobar" "login": "foobar"
} }
""" """

25
plugins/modules/pacemaker_resource.py
View file

@ -8,8 +8,7 @@
from __future__ import absolute_import, division, print_function from __future__ import absolute_import, division, print_function
__metaclass__ = type __metaclass__ = type
DOCUMENTATION = ''' DOCUMENTATION = r"""
---
module: pacemaker_resource module: pacemaker_resource
short_description: Manage pacemaker resources short_description: Manage pacemaker resources
author: author:
@ -28,7 +27,7 @@ options:
state: state:
description: description:
- Indicate desired state for cluster resource. - Indicate desired state for cluster resource.
choices: [ present, absent, enabled, disabled ] choices: [present, absent, enabled, disabled]
default: present default: present
type: str type: str
name: name:
@ -89,7 +88,7 @@ options:
description: description:
- Action to apply to resource. - Action to apply to resource.
type: str type: str
choices: [ clone, master, group, promotable ] choices: [clone, master, group, promotable]
argument_option: argument_option:
description: description:
- Options to associate with resource action. - Options to associate with resource action.
@ -100,9 +99,9 @@ options:
- Timeout period for polling the resource creation. - Timeout period for polling the resource creation.
type: int type: int
default: 300 default: 300
''' """
EXAMPLES = ''' EXAMPLES = r"""
--- ---
- name: Create pacemaker resource - name: Create pacemaker resource
hosts: localhost hosts: localhost
@ -124,15 +123,15 @@ EXAMPLES = '''
- operation_action: monitor - operation_action: monitor
operation_option: operation_option:
- interval=20 - interval=20
''' """
RETURN = ''' RETURN = r"""
cluster_resources: cluster_resources:
description: The cluster resource output message. description: The cluster resource output message.
type: str type: str
sample: "Assumed agent name ocf:heartbeat:IPaddr2 (deduced from IPaddr2)" sample: "Assumed agent name ocf:heartbeat:IPaddr2 (deduced from IPaddr2)"
returned: always returned: always
''' """
from ansible_collections.community.general.plugins.module_utils.module_helper import StateModuleHelper from ansible_collections.community.general.plugins.module_utils.module_helper import StateModuleHelper
from ansible_collections.community.general.plugins.module_utils.pacemaker import pacemaker_runner, get_pacemaker_maintenance_mode from ansible_collections.community.general.plugins.module_utils.pacemaker import pacemaker_runner, get_pacemaker_maintenance_mode

18
plugins/modules/packet_device.py
View file

@ -268,16 +268,14 @@ devices:
description: Information about each device that was processed. description: Information about each device that was processed.
type: list type: list
sample: sample:
- { - "hostname": "my-server.com"
"hostname": "my-server.com", "id": "2a5122b9-c323-4d5c-b53c-9ad3f54273e7"
"id": "2a5122b9-c323-4d5c-b53c-9ad3f54273e7", "public_ipv4": "147.229.15.12"
"public_ipv4": "147.229.15.12", "private-ipv4": "10.0.15.12"
"private-ipv4": "10.0.15.12", "tags": []
"tags": [], "locked": false
"locked": false, "state": "provisioning"
"state": "provisioning", "public_ipv6": "2604:1380:2:5200::3"
"public_ipv6": "2604:1380:2:5200::3"
}
returned: success returned: success
""" """

9
plugins/modules/packet_sshkey.py
View file

@ -91,9 +91,10 @@ changed:
sample: true sample: true
returned: always returned: always
sshkeys: sshkeys:
description: Information about sshkeys that were created/removed. description: Information about sshkeys that were created/removed.
type: list type: list
sample: [ sample:
[
{ {
"fingerprint": "5c:93:74:7c:ed:07:17:62:28:75:79:23:d6:08:93:46", "fingerprint": "5c:93:74:7c:ed:07:17:62:28:75:79:23:d6:08:93:46",
"id": "41d61bd8-3342-428b-a09c-e67bdd18a9b7", "id": "41d61bd8-3342-428b-a09c-e67bdd18a9b7",
@ -101,7 +102,7 @@ sshkeys:
"label": "mynewkey33" "label": "mynewkey33"
} }
] ]
returned: always returned: always
""" """
import os import os

50
plugins/modules/parted.py
View file

@ -140,35 +140,31 @@ partition_info:
script: script:
description: Parted script executed by module. description: Parted script executed by module.
type: str type: str
sample: { sample:
"disk": { "disk":
"dev": "/dev/sdb", "dev": "/dev/sdb"
"logical_block": 512, "logical_block": 512
"model": "VMware Virtual disk", "model": "VMware Virtual disk"
"physical_block": 512, "physical_block": 512
"size": 5.0, "size": 5.0
"table": "msdos", "table": "msdos"
"unit": "gib" "unit": "gib"
}, "partitions":
"partitions": [{ - "begin": 0.0
"begin": 0.0, "end": 1.0
"end": 1.0, "flags": ["boot", "lvm"]
"flags": ["boot", "lvm"], "fstype": ""
"fstype": "", "name": ""
"name": "", "num": 1
"num": 1,
"size": 1.0 "size": 1.0
}, { - "begin": 1.0
"begin": 1.0, "end": 5.0
"end": 5.0, "flags": []
"flags": [], "fstype": ""
"fstype": "", "name": ""
"name": "", "num": 2
"num": 2,
"size": 4.0 "size": 4.0
}], "script": "unit KiB print "
"script": "unit KiB print "
}
""" """
EXAMPLES = r""" EXAMPLES = r"""

60
plugins/modules/pip_package_info.py
View file

@ -60,36 +60,36 @@ packages:
type: dict type: dict
sample: sample:
"packages": { "packages": {
"pip": { "pip": {
"Babel": [ "Babel": [
{ {
"name": "Babel", "name": "Babel",
"source": "pip", "source": "pip",
"version": "2.6.0" "version": "2.6.0"
} }
], ],
"Flask": [ "Flask": [
{ {
"name": "Flask", "name": "Flask",
"source": "pip", "source": "pip",
"version": "1.0.2" "version": "1.0.2"
} }
], ],
"Flask-SQLAlchemy": [ "Flask-SQLAlchemy": [
{ {
"name": "Flask-SQLAlchemy", "name": "Flask-SQLAlchemy",
"source": "pip", "source": "pip",
"version": "2.3.2" "version": "2.3.2"
} }
], ],
"Jinja2": [ "Jinja2": [
{ {
"name": "Jinja2", "name": "Jinja2",
"source": "pip", "source": "pip",
"version": "2.10" "version": "2.10"
} }
], ],
}, },
} }
""" """

24
plugins/modules/pritunl_org.py
View file

@ -63,18 +63,18 @@ EXAMPLES = r"""
RETURN = r""" RETURN = r"""
response: response:
description: JSON representation of a Pritunl Organization. description: JSON representation of a Pritunl Organization.
returned: success returned: success
type: dict type: dict
sample: sample:
{ {
"auth_api": false, "auth_api": false,
"name": "Foo", "name": "Foo",
"auth_token": null, "auth_token": null,
"user_count": 0, "user_count": 0,
"auth_secret": null, "auth_secret": null,
"id": "csftwlu6uhralzi2dpmhekz3", "id": "csftwlu6uhralzi2dpmhekz3"
} }
""" """

62
plugins/modules/pritunl_org_info.py
View file

@ -41,37 +41,37 @@ EXAMPLES = r"""
RETURN = r""" RETURN = r"""
organizations: organizations:
description: List of Pritunl organizations. description: List of Pritunl organizations.
returned: success returned: success
type: list type: list
elements: dict elements: dict
sample: sample:
[ [
{ {
"auth_api": false, "auth_api": false,
"name": "FooOrg", "name": "FooOrg",
"auth_token": null, "auth_token": null,
"user_count": 0, "user_count": 0,
"auth_secret": null, "auth_secret": null,
"id": "csftwlu6uhralzi2dpmhekz3", "id": "csftwlu6uhralzi2dpmhekz3"
}, },
{ {
"auth_api": false, "auth_api": false,
"name": "MyOrg", "name": "MyOrg",
"auth_token": null, "auth_token": null,
"user_count": 3, "user_count": 3,
"auth_secret": null, "auth_secret": null,
"id": "58070daee63f3b2e6e472c36", "id": "58070daee63f3b2e6e472c36"
}, },
{ {
"auth_api": false, "auth_api": false,
"name": "BarOrg", "name": "BarOrg",
"auth_token": null, "auth_token": null,
"user_count": 0, "user_count": 0,
"auth_secret": null, "auth_secret": null,
"id": "v1sncsxxybnsylc8gpqg85pg", "id": "v1sncsxxybnsylc8gpqg85pg"
} }
] ]
""" """
from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.basic import AnsibleModule

59
plugins/modules/pritunl_user.py
View file

@ -115,35 +115,36 @@ EXAMPLES = r"""
RETURN = r""" RETURN = r"""
response: response:
description: JSON representation of Pritunl Users. description: JSON representation of Pritunl Users.
returned: success returned: success
type: dict type: dict
sample: sample:
{ {
"audit": false, "audit": false,
"auth_type": "google", "auth_type": "google",
"bypass_secondary": false, "bypass_secondary": false,
"client_to_client": false, "client_to_client": false,
"disabled": false, "disabled": false,
"dns_mapping": null, "dns_mapping": null,
"dns_servers": null, "dns_servers": null,
"dns_suffix": null, "dns_suffix": null,
"email": "foo@bar.com", "email": "foo@bar.com",
"gravatar": true, "gravatar": true,
"groups": [ "groups": [
"foo", "bar" "foo",
], "bar"
"id": "5d070dafe63q3b2e6s472c3b", ],
"name": "foo@acme.com", "id": "5d070dafe63q3b2e6s472c3b",
"network_links": [], "name": "foo@acme.com",
"organization": "58070daee6sf342e6e4s2c36", "network_links": [],
"organization_name": "Acme", "organization": "58070daee6sf342e6e4s2c36",
"otp_auth": true, "organization_name": "Acme",
"otp_secret": "35H5EJA3XB2$4CWG", "otp_auth": true,
"pin": false, "otp_secret": "35H5EJA3XB2$4CWG",
"port_forwarding": [], "pin": false,
"servers": [], "port_forwarding": [],
} "servers": []
}
""" """

65
plugins/modules/pritunl_user_info.py
View file

@ -58,38 +58,39 @@ EXAMPLES = r"""
RETURN = r""" RETURN = r"""
users: users:
description: List of Pritunl users. description: List of Pritunl users.
returned: success returned: success
type: list type: list
elements: dict elements: dict
sample: sample:
[ [
{ {
"audit": false, "audit": false,
"auth_type": "google", "auth_type": "google",
"bypass_secondary": false, "bypass_secondary": false,
"client_to_client": false, "client_to_client": false,
"disabled": false, "disabled": false,
"dns_mapping": null, "dns_mapping": null,
"dns_servers": null, "dns_servers": null,
"dns_suffix": null, "dns_suffix": null,
"email": "foo@bar.com", "email": "foo@bar.com",
"gravatar": true, "gravatar": true,
"groups": [ "groups": [
"foo", "bar" "foo",
], "bar"
"id": "5d070dafe63q3b2e6s472c3b", ],
"name": "foo@acme.com", "id": "5d070dafe63q3b2e6s472c3b",
"network_links": [], "name": "foo@acme.com",
"organization": "58070daee6sf342e6e4s2c36", "network_links": [],
"organization_name": "Acme", "organization": "58070daee6sf342e6e4s2c36",
"otp_auth": true, "organization_name": "Acme",
"otp_secret": "35H5EJA3XB2$4CWG", "otp_auth": true,
"pin": false, "otp_secret": "35H5EJA3XB2$4CWG",
"port_forwarding": [], "pin": false,
"servers": [], "port_forwarding": [],
} "servers": []
] }
]
""" """
from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.basic import AnsibleModule

2
plugins/modules/pushbullet.py
View file

@ -81,7 +81,7 @@ EXAMPLES = r"""
community.general.pushbullet: community.general.pushbullet:
api_key: ABC123abc123ABC123abc123ABC123ab api_key: ABC123abc123ABC123abc123ABC123ab
channel: my-awesome-channel channel: my-awesome-channel
title: Broadcasting a message to the #my-awesome-channel folks title: "Broadcasting a message to the #my-awesome-channel folks"
- name: Sends a push notification with title and body to a channel - name: Sends a push notification with title and body to a channel
community.general.pushbullet: community.general.pushbullet:

32
plugins/modules/redis_info.py
View file

@ -63,7 +63,8 @@ info:
description: The default set of server information sections U(https://redis.io/commands/info). description: The default set of server information sections U(https://redis.io/commands/info).
returned: success returned: success
type: dict type: dict
sample: { sample:
{
"active_defrag_hits": 0, "active_defrag_hits": 0,
"active_defrag_key_hits": 0, "active_defrag_key_hits": 0,
"active_defrag_key_misses": 0, "active_defrag_key_misses": 0,
@ -196,20 +197,21 @@ cluster:
returned: success if O(cluster=true) returned: success if O(cluster=true)
version_added: 9.1.0 version_added: 9.1.0
type: dict type: dict
sample: { sample:
"cluster_state": ok, {
"cluster_slots_assigned": 16384, "cluster_state": "ok",
"cluster_slots_ok": 16384, "cluster_slots_assigned": 16384,
"cluster_slots_pfail": 0, "cluster_slots_ok": 16384,
"cluster_slots_fail": 0, "cluster_slots_pfail": 0,
"cluster_known_nodes": 6, "cluster_slots_fail": 0,
"cluster_size": 3, "cluster_known_nodes": 6,
"cluster_current_epoch": 6, "cluster_size": 3,
"cluster_my_epoch": 2, "cluster_current_epoch": 6,
"cluster_stats_messages_sent": 1483972, "cluster_my_epoch": 2,
"cluster_stats_messages_received": 1483968, "cluster_stats_messages_sent": 1483972,
"total_cluster_links_buffer_limit_exceeded": 0 "cluster_stats_messages_received": 1483968,
} "total_cluster_links_buffer_limit_exceeded": 0
}
""" """
import traceback import traceback

123
plugins/modules/rhevm.py
View file

@ -153,67 +153,68 @@ options:
RETURN = r""" RETURN = r"""
vm: vm:
description: Returns all of the VMs variables and execution. description: Returns all of the VMs variables and execution.
returned: always returned: always
type: dict type: dict
sample: { sample:
"boot_order": [ {
"hd", "boot_order": [
"network" "hd",
], "network"
"changed": true, ],
"changes": [ "changed": true,
"Delete Protection" "changes": [
], "Delete Protection"
"cluster": "C1", ],
"cpu_share": "0", "cluster": "C1",
"created": false, "cpu_share": "0",
"datacenter": "Default", "created": false,
"del_prot": true, "datacenter": "Default",
"disks": [ "del_prot": true,
{ "disks": [
"domain": "ssd-san", {
"name": "OS", "domain": "ssd-san",
"size": 40 "name": "OS",
} "size": 40
], }
"eth0": "00:00:5E:00:53:00", ],
"eth1": "00:00:5E:00:53:01", "eth0": "00:00:5E:00:53:00",
"eth2": "00:00:5E:00:53:02", "eth1": "00:00:5E:00:53:01",
"exists": true, "eth2": "00:00:5E:00:53:02",
"failed": false, "exists": true,
"ifaces": [ "failed": false,
{ "ifaces": [
"name": "eth0", {
"vlan": "Management" "name": "eth0",
}, "vlan": "Management"
{ },
"name": "eth1", {
"vlan": "Internal" "name": "eth1",
}, "vlan": "Internal"
{ },
"name": "eth2", {
"vlan": "External" "name": "eth2",
} "vlan": "External"
], }
"image": false, ],
"mempol": "0", "image": false,
"msg": [ "mempol": "0",
"VM exists", "msg": [
"cpu_share was already set to 0", "VM exists",
"VM high availability was already set to True", "cpu_share was already set to 0",
"The boot order has already been set", "VM high availability was already set to True",
"VM delete protection has been set to True", "The boot order has already been set",
"Disk web2_Disk0_OS already exists", "VM delete protection has been set to True",
"The VM starting host was already set to host416" "Disk web2_Disk0_OS already exists",
], "The VM starting host was already set to host416"
"name": "web2", ],
"type": "server", "name": "web2",
"uuid": "4ba5a1be-e60b-4368-9533-920f156c817b", "type": "server",
"vm_ha": true, "uuid": "4ba5a1be-e60b-4368-9533-920f156c817b",
"vmcpu": "4", "vm_ha": true,
"vmhost": "host416", "vmcpu": "4",
"vmmem": "16" "vmhost": "host416",
"vmmem": "16"
} }
""" """

4
plugins/modules/rocketchat.py
View file

@ -124,7 +124,7 @@ EXAMPLES = r"""
domain: chat.example.com domain: chat.example.com
token: thetoken/generatedby/rocketchat token: thetoken/generatedby/rocketchat
msg: '{{ inventory_hostname }} completed' msg: '{{ inventory_hostname }} completed'
channel: #ansible channel: "#ansible"
username: 'Ansible on {{ inventory_hostname }}' username: 'Ansible on {{ inventory_hostname }}'
icon_url: http://www.example.com/some-image-file.png icon_url: http://www.example.com/some-image-file.png
link_names: 0 link_names: 0
@ -147,7 +147,7 @@ EXAMPLES = r"""
domain: chat.example.com domain: chat.example.com
attachments: attachments:
- text: Display my system load on host A and B - text: Display my system load on host A and B
color: #ff00dd color: "#ff00dd"
title: System load title: System load
fields: fields:
- title: System A - title: System A

85
plugins/modules/rundeck_job_executions_info.py
View file

@ -80,46 +80,53 @@ paging:
description: Maximum number of results per page. description: Maximum number of results per page.
type: int type: int
returned: success returned: success
sample: {"count": 20, "total": 100, "offset": 0, "max": 20} sample:
{
"count": 20,
"total": 100,
"offset": 0,
"max": 20
}
executions: executions:
description: Job executions list. description: Job executions list.
returned: always returned: always
type: list type: list
elements: dict elements: dict
sample: [ sample:
{ [
"id": 1, {
"href": "https://rundeck.example.org/api/39/execution/1", "id": 1,
"permalink": "https://rundeck.example.org/project/myproject/execution/show/1", "href": "https://rundeck.example.org/api/39/execution/1",
"status": "succeeded", "permalink": "https://rundeck.example.org/project/myproject/execution/show/1",
"project": "myproject", "status": "succeeded",
"executionType": "user", "project": "myproject",
"user": "admin", "executionType": "user",
"date-started": { "user": "admin",
"unixtime": 1633525515026, "date-started": {
"date": "2021-10-06T13:05:15Z" "unixtime": 1633525515026,
}, "date": "2021-10-06T13:05:15Z"
"date-ended": { },
"unixtime": 1633525518386, "date-ended": {
"date": "2021-10-06T13:05:18Z" "unixtime": 1633525518386,
}, "date": "2021-10-06T13:05:18Z"
"job": { },
"id": "697af0c4-72d3-4c15-86a3-b5bfe3c6cb6a", "job": {
"averageDuration": 6381, "id": "697af0c4-72d3-4c15-86a3-b5bfe3c6cb6a",
"name": "Test", "averageDuration": 6381,
"group": "", "name": "Test",
"project": "myproject", "group": "",
"description": "", "project": "myproject",
"options": { "description": "",
"exit_code": "0" "options": {
}, "exit_code": "0"
"href": "https://rundeck.example.org/api/39/job/697af0c4-72d3-4c15-86a3-b5bfe3c6cb6a", },
"permalink": "https://rundeck.example.org/project/myproject/job/show/697af0c4-72d3-4c15-86a3-b5bfe3c6cb6a" "href": "https://rundeck.example.org/api/39/job/697af0c4-72d3-4c15-86a3-b5bfe3c6cb6a",
}, "permalink": "https://rundeck.example.org/project/myproject/job/show/697af0c4-72d3-4c15-86a3-b5bfe3c6cb6a"
"description": "Plugin[com.batix.rundeck.plugins.AnsiblePlaybookInlineWorkflowStep, nodeStep: false]", },
"argstring": "-exit_code 0", "description": "Plugin[com.batix.rundeck.plugins.AnsiblePlaybookInlineWorkflowStep, nodeStep: false]",
"serverUUID": "5b9a1438-fa3a-457e-b254-8f3d70338068" "argstring": "-exit_code 0",
} "serverUUID": "5b9a1438-fa3a-457e-b254-8f3d70338068"
}
] ]
""" """

85
plugins/modules/rundeck_job_run.py
View file

@ -133,48 +133,49 @@ EXAMPLES = r"""
RETURN = r""" RETURN = r"""
execution_info: execution_info:
description: Rundeck job execution metadata. description: Rundeck job execution metadata.
returned: always returned: always
type: dict type: dict
sample: { sample:
"msg": "Job execution succeeded!", {
"execution_info": { "msg": "Job execution succeeded!",
"id": 1, "execution_info": {
"href": "https://rundeck.example.org/api/39/execution/1", "id": 1,
"permalink": "https://rundeck.example.org/project/myproject/execution/show/1", "href": "https://rundeck.example.org/api/39/execution/1",
"status": "succeeded", "permalink": "https://rundeck.example.org/project/myproject/execution/show/1",
"project": "myproject", "status": "succeeded",
"executionType": "user", "project": "myproject",
"user": "admin", "executionType": "user",
"date-started": { "user": "admin",
"unixtime": 1633449020784, "date-started": {
"date": "2021-10-05T15:50:20Z" "unixtime": 1633449020784,
}, "date": "2021-10-05T15:50:20Z"
"date-ended": { },
"unixtime": 1633449026358, "date-ended": {
"date": "2021-10-05T15:50:26Z" "unixtime": 1633449026358,
}, "date": "2021-10-05T15:50:26Z"
"job": { },
"id": "697af0c4-72d3-4c15-86a3-b5bfe3c6cb6a", "job": {
"averageDuration": 4917, "id": "697af0c4-72d3-4c15-86a3-b5bfe3c6cb6a",
"name": "Test", "averageDuration": 4917,
"group": "", "name": "Test",
"project": "myproject", "group": "",
"description": "", "project": "myproject",
"options": { "description": "",
"exit_code": "0" "options": {
}, "exit_code": "0"
"href": "https://rundeck.example.org/api/39/job/697af0c4-72d3-4c15-86a3-b5bfe3c6cb6a", },
"permalink": "https://rundeck.example.org/project/myproject/job/show/697af0c4-72d3-4c15-86a3-b5bfe3c6cb6a" "href": "https://rundeck.example.org/api/39/job/697af0c4-72d3-4c15-86a3-b5bfe3c6cb6a",
}, "permalink": "https://rundeck.example.org/project/myproject/job/show/697af0c4-72d3-4c15-86a3-b5bfe3c6cb6a"
"description": "sleep 5 && echo 'Test!' && exit ${option.exit_code}", },
"argstring": "-exit_code 0", "description": "sleep 5 && echo 'Test!' && exit ${option.exit_code}",
"serverUUID": "5b9a1438-fa3a-457e-b254-8f3d70338068", "argstring": "-exit_code 0",
"successfulNodes": [ "serverUUID": "5b9a1438-fa3a-457e-b254-8f3d70338068",
"localhost" "successfulNodes": [
], "localhost"
"output": "Test!" ],
} "output": "Test!"
}
} }
""" """

40
plugins/modules/scaleway_compute_private_network.py
View file

@ -93,26 +93,26 @@ EXAMPLES = r"""
RETURN = r""" RETURN = r"""
scaleway_compute_private_network: scaleway_compute_private_network:
description: Information on the VPC. description: Information on the VPC.
returned: success when O(state=present) returned: success when O(state=present)
type: dict type: dict
sample: sample:
{ {
"created_at": "2022-01-15T11:11:12.676445Z", "created_at": "2022-01-15T11:11:12.676445Z",
"id": "12345678-f1e6-40ec-83e5-12345d67ed89", "id": "12345678-f1e6-40ec-83e5-12345d67ed89",
"name": "network", "name": "network",
"organization_id": "a123b4cd-ef5g-678h-90i1-jk2345678l90", "organization_id": "a123b4cd-ef5g-678h-90i1-jk2345678l90",
"project_id": "a123b4cd-ef5g-678h-90i1-jk2345678l90", "project_id": "a123b4cd-ef5g-678h-90i1-jk2345678l90",
"tags": [ "tags": [
"tag1", "tag1",
"tag2", "tag2",
"tag3", "tag3",
"tag4", "tag4",
"tag5" "tag5"
], ],
"updated_at": "2022-01-15T11:12:04.624837Z", "updated_at": "2022-01-15T11:12:04.624837Z",
"zone": "fr-par-2" "zone": "fr-par-2"
} }
""" """
from ansible_collections.community.general.plugins.module_utils.scaleway import SCALEWAY_LOCATION, scaleway_argument_spec, Scaleway from ansible_collections.community.general.plugins.module_utils.scaleway import SCALEWAY_LOCATION, scaleway_argument_spec, Scaleway

39
plugins/modules/scaleway_database_backup.py
View file

@ -143,25 +143,26 @@ EXAMPLES = r"""
RETURN = r""" RETURN = r"""
metadata: metadata:
description: Backup metadata. description: Backup metadata.
returned: when O(state=present), O(state=exported), or O(state=restored) returned: when O(state=present), O(state=exported), or O(state=restored)
type: dict type: dict
sample: { sample:
"metadata": { {
"created_at": "2020-08-06T12:42:05.631049Z", "metadata": {
"database_name": "my-database", "created_at": "2020-08-06T12:42:05.631049Z",
"download_url": null, "database_name": "my-database",
"download_url_expires_at": null, "download_url": null,
"expires_at": null, "download_url_expires_at": null,
"id": "a15297bd-0c4a-4b4f-8fbb-b36a35b7eb07", "expires_at": null,
"instance_id": "617be32e-6497-4ed7-b4c7-0ee5a81edf49", "id": "a15297bd-0c4a-4b4f-8fbb-b36a35b7eb07",
"instance_name": "my-instance", "instance_id": "617be32e-6497-4ed7-b4c7-0ee5a81edf49",
"name": "backup_name", "instance_name": "my-instance",
"region": "fr-par", "name": "backup_name",
"size": 600000, "region": "fr-par",
"status": "ready", "size": 600000,
"updated_at": "2020-08-06T12:42:10.581649Z" "status": "ready",
} "updated_at": "2020-08-06T12:42:10.581649Z"
}
} }
""" """

60
plugins/modules/scaleway_image_info.py
View file

@ -58,36 +58,36 @@ scaleway_image_info:
elements: dict elements: dict
sample: sample:
"scaleway_image_info": [ "scaleway_image_info": [
{ {
"arch": "x86_64", "arch": "x86_64",
"creation_date": "2018-07-17T16:18:49.276456+00:00", "creation_date": "2018-07-17T16:18:49.276456+00:00",
"default_bootscript": { "default_bootscript": {
"architecture": "x86_64", "architecture": "x86_64",
"bootcmdargs": "LINUX_COMMON scaleway boot=local nbd.max_part=16", "bootcmdargs": "LINUX_COMMON scaleway boot=local nbd.max_part=16",
"default": false, "default": false,
"dtb": "", "dtb": "",
"id": "15fbd2f7-a0f9-412b-8502-6a44da8d98b8", "id": "15fbd2f7-a0f9-412b-8502-6a44da8d98b8",
"initrd": "http://169.254.42.24/initrd/initrd-Linux-x86_64-v3.14.5.gz", "initrd": "http://169.254.42.24/initrd/initrd-Linux-x86_64-v3.14.5.gz",
"kernel": "http://169.254.42.24/kernel/x86_64-mainline-lts-4.9-4.9.93-rev1/vmlinuz-4.9.93", "kernel": "http://169.254.42.24/kernel/x86_64-mainline-lts-4.9-4.9.93-rev1/vmlinuz-4.9.93",
"organization": "11111111-1111-4111-8111-111111111111", "organization": "11111111-1111-4111-8111-111111111111",
"public": true, "public": true,
"title": "x86_64 mainline 4.9.93 rev1" "title": "x86_64 mainline 4.9.93 rev1"
}, },
"extra_volumes": [], "extra_volumes": [],
"from_server": null, "from_server": null,
"id": "00ae4a88-3252-4eda-9feb-5f6b56bf5ef0", "id": "00ae4a88-3252-4eda-9feb-5f6b56bf5ef0",
"modification_date": "2018-07-17T16:42:06.319315+00:00", "modification_date": "2018-07-17T16:42:06.319315+00:00",
"name": "Debian Stretch", "name": "Debian Stretch",
"organization": "51b656e3-4865-41e8-adbc-0c45bdd780db", "organization": "51b656e3-4865-41e8-adbc-0c45bdd780db",
"public": true, "public": true,
"root_volume": { "root_volume": {
"id": "da32dfbb-c5ff-476d-ae2d-c297dd09b7dd", "id": "da32dfbb-c5ff-476d-ae2d-c297dd09b7dd",
"name": "snapshot-2a7229dc-d431-4dc5-b66e-95db08b773af-2018-07-17_16:18", "name": "snapshot-2a7229dc-d431-4dc5-b66e-95db08b773af-2018-07-17_16:18",
"size": 25000000000, "size": 25000000000,
"volume_type": "l_ssd" "volume_type": "l_ssd"
}, },
"state": "available" "state": "available"
} }
] ]
""" """

29
plugins/modules/scaleway_ip.py
View file

@ -90,23 +90,24 @@ EXAMPLES = r"""
RETURN = r""" RETURN = r"""
data: data:
description: This is only present when O(state=present). description: This is only present when O(state=present).
returned: when O(state=present) returned: when O(state=present)
type: dict type: dict
sample: { sample:
{
"ips": [ "ips": [
{ {
"organization": "951df375-e094-4d26-97c1-ba548eeb9c42", "organization": "951df375-e094-4d26-97c1-ba548eeb9c42",
"reverse": null, "reverse": null,
"id": "dd9e8df6-6775-4863-b517-e0b0ee3d7477", "id": "dd9e8df6-6775-4863-b517-e0b0ee3d7477",
"server": { "server": {
"id": "3f1568ca-b1a2-4e98-b6f7-31a0588157f1", "id": "3f1568ca-b1a2-4e98-b6f7-31a0588157f1",
"name": "ansible_tuto-1" "name": "ansible_tuto-1"
}, },
"address": "212.47.232.136" "address": "212.47.232.136"
} }
] ]
} }
""" """
from ansible_collections.community.general.plugins.module_utils.scaleway import SCALEWAY_LOCATION, scaleway_argument_spec, Scaleway from ansible_collections.community.general.plugins.module_utils.scaleway import SCALEWAY_LOCATION, scaleway_argument_spec, Scaleway

18
plugins/modules/scaleway_ip_info.py
View file

@ -58,16 +58,16 @@ scaleway_ip_info:
elements: dict elements: dict
sample: sample:
"scaleway_ip_info": [ "scaleway_ip_info": [
{ {
"address": "163.172.170.243", "address": "163.172.170.243",
"id": "ea081794-a581-8899-8451-386ddaf0a451", "id": "ea081794-a581-8899-8451-386ddaf0a451",
"organization": "3f709602-5e6c-4619-b80c-e324324324af", "organization": "3f709602-5e6c-4619-b80c-e324324324af",
"reverse": null, "reverse": null,
"server": { "server": {
"id": "12f19bc7-109c-4517-954c-e6b3d0311363", "id": "12f19bc7-109c-4517-954c-e6b3d0311363",
"name": "scw-e0d158" "name": "scw-e0d158"
}
} }
}
] ]
""" """

42
plugins/modules/scaleway_organization_info.py
View file

@ -45,27 +45,27 @@ scaleway_organization_info:
elements: dict elements: dict
sample: sample:
"scaleway_organization_info": [ "scaleway_organization_info": [
{ {
"address_city_name": "Paris", "address_city_name": "Paris",
"address_country_code": "FR", "address_country_code": "FR",
"address_line1": "42 Rue de l'univers", "address_line1": "42 Rue de l'univers",
"address_line2": null, "address_line2": null,
"address_postal_code": "75042", "address_postal_code": "75042",
"address_subdivision_code": "FR-75", "address_subdivision_code": "FR-75",
"creation_date": "2018-08-06T13:43:28.508575+00:00", "creation_date": "2018-08-06T13:43:28.508575+00:00",
"currency": "EUR", "currency": "EUR",
"customer_class": "individual", "customer_class": "individual",
"id": "3f709602-5e6c-4619-b80c-e8432ferewtr", "id": "3f709602-5e6c-4619-b80c-e8432ferewtr",
"locale": "fr_FR", "locale": "fr_FR",
"modification_date": "2018-08-06T14:56:41.401685+00:00", "modification_date": "2018-08-06T14:56:41.401685+00:00",
"name": "James Bond", "name": "James Bond",
"support_id": "694324", "support_id": "694324",
"support_level": "basic", "support_level": "basic",
"support_pin": "9324", "support_pin": "9324",
"users": [], "users": [],
"vat_number": null, "vat_number": null,
"warnings": [] "warnings": []
} }
] ]
""" """

40
plugins/modules/scaleway_private_network.py
View file

@ -89,26 +89,26 @@ EXAMPLES = r"""
RETURN = r""" RETURN = r"""
scaleway_private_network: scaleway_private_network:
description: Information on the VPC. description: Information on the VPC.
returned: success when O(state=present) returned: success when O(state=present)
type: dict type: dict
sample: sample:
{ {
"created_at": "2022-01-15T11:11:12.676445Z", "created_at": "2022-01-15T11:11:12.676445Z",
"id": "12345678-f1e6-40ec-83e5-12345d67ed89", "id": "12345678-f1e6-40ec-83e5-12345d67ed89",
"name": "network", "name": "network",
"organization_id": "a123b4cd-ef5g-678h-90i1-jk2345678l90", "organization_id": "a123b4cd-ef5g-678h-90i1-jk2345678l90",
"project_id": "a123b4cd-ef5g-678h-90i1-jk2345678l90", "project_id": "a123b4cd-ef5g-678h-90i1-jk2345678l90",
"tags": [ "tags": [
"tag1", "tag1",
"tag2", "tag2",
"tag3", "tag3",
"tag4", "tag4",
"tag5" "tag5"
], ],
"updated_at": "2022-01-15T11:12:04.624837Z", "updated_at": "2022-01-15T11:12:04.624837Z",
"zone": "fr-par-2" "zone": "fr-par-2"
} }
""" """
from ansible_collections.community.general.plugins.module_utils.scaleway import SCALEWAY_LOCATION, scaleway_argument_spec, Scaleway from ansible_collections.community.general.plugins.module_utils.scaleway import SCALEWAY_LOCATION, scaleway_argument_spec, Scaleway

33
plugins/modules/scaleway_security_group.py
View file

@ -109,22 +109,23 @@ EXAMPLES = r"""
RETURN = r""" RETURN = r"""
data: data:
description: This is only present when O(state=present). description: This is only present when O(state=present).
returned: when O(state=present) returned: when O(state=present)
type: dict type: dict
sample: { sample:
"scaleway_security_group": { {
"description": "my security group description", "scaleway_security_group": {
"enable_default_security": true, "description": "my security group description",
"id": "0168fb1f-cc46-4f69-b4be-c95d2a19bcae", "enable_default_security": true,
"inbound_default_policy": "accept", "id": "0168fb1f-cc46-4f69-b4be-c95d2a19bcae",
"name": "security_group", "inbound_default_policy": "accept",
"organization": "43a3b6c8-916f-477b-b7ec-ff1898f5fdd9", "name": "security_group",
"organization_default": false, "organization": "43a3b6c8-916f-477b-b7ec-ff1898f5fdd9",
"outbound_default_policy": "accept", "organization_default": false,
"servers": [], "outbound_default_policy": "accept",
"stateful": false "servers": [],
} "stateful": false
}
} }
""" """

28
plugins/modules/scaleway_security_group_info.py
View file

@ -57,20 +57,20 @@ scaleway_security_group_info:
elements: dict elements: dict
sample: sample:
"scaleway_security_group_info": [ "scaleway_security_group_info": [
{ {
"description": "test-ams", "description": "test-ams",
"enable_default_security": true, "enable_default_security": true,
"id": "7fcde327-8bed-43a6-95c4-6dfbc56d8b51", "id": "7fcde327-8bed-43a6-95c4-6dfbc56d8b51",
"name": "test-ams", "name": "test-ams",
"organization": "3f709602-5e6c-4619-b80c-e841c89734af", "organization": "3f709602-5e6c-4619-b80c-e841c89734af",
"organization_default": false, "organization_default": false,
"servers": [ "servers": [
{ {
"id": "12f19bc7-108c-4517-954c-e6b3d0311363", "id": "12f19bc7-108c-4517-954c-e6b3d0311363",
"name": "scw-e0d158" "name": "scw-e0d158"
} }
] ]
} }
] ]
""" """

31
plugins/modules/scaleway_security_group_rule.py
View file

@ -116,21 +116,22 @@ EXAMPLES = r"""
RETURN = r""" RETURN = r"""
data: data:
description: This is only present when O(state=present). description: This is only present when O(state=present).
returned: when O(state=present) returned: when O(state=present)
type: dict type: dict
sample: { sample:
"scaleway_security_group_rule": { {
"direction": "inbound", "scaleway_security_group_rule": {
"protocol": "TCP", "direction": "inbound",
"ip_range": "0.0.0.0/0", "protocol": "TCP",
"dest_port_from": 80, "ip_range": "0.0.0.0/0",
"action": "accept", "dest_port_from": 80,
"position": 2, "action": "accept",
"dest_port_to": null, "position": 2,
"editable": null, "dest_port_to": null,
"id": "10cb0b9a-80f6-4830-abd7-a31cd828b5e9" "editable": null,
} "id": "10cb0b9a-80f6-4830-abd7-a31cd828b5e9"
}
} }
""" """

184
plugins/modules/scaleway_server_info.py
View file

@ -58,102 +58,102 @@ scaleway_server_info:
elements: dict elements: dict
sample: sample:
"scaleway_server_info": [ "scaleway_server_info": [
{ {
"arch": "x86_64", "arch": "x86_64",
"boot_type": "local", "boot_type": "local",
"bootscript": { "bootscript": {
"architecture": "x86_64", "architecture": "x86_64",
"bootcmdargs": "LINUX_COMMON scaleway boot=local nbd.max_part=16", "bootcmdargs": "LINUX_COMMON scaleway boot=local nbd.max_part=16",
"default": true, "default": true,
"dtb": "", "dtb": "",
"id": "b1e68c26-a19c-4eac-9222-498b22bd7ad9", "id": "b1e68c26-a19c-4eac-9222-498b22bd7ad9",
"initrd": "http://169.254.42.24/initrd/initrd-Linux-x86_64-v3.14.5.gz", "initrd": "http://169.254.42.24/initrd/initrd-Linux-x86_64-v3.14.5.gz",
"kernel": "http://169.254.42.24/kernel/x86_64-mainline-lts-4.4-4.4.127-rev1/vmlinuz-4.4.127", "kernel": "http://169.254.42.24/kernel/x86_64-mainline-lts-4.4-4.4.127-rev1/vmlinuz-4.4.127",
"organization": "11111111-1111-4111-8111-111111111111", "organization": "11111111-1111-4111-8111-111111111111",
"public": true, "public": true,
"title": "x86_64 mainline 4.4.127 rev1" "title": "x86_64 mainline 4.4.127 rev1"
}, },
"commercial_type": "START1-XS", "commercial_type": "START1-XS",
"creation_date": "2018-08-14T21:36:56.271545+00:00",
"dynamic_ip_required": false,
"enable_ipv6": false,
"extra_networks": [],
"hostname": "scw-e0d256",
"id": "12f19bc7-108c-4517-954c-e6b3d0311363",
"image": {
"arch": "x86_64",
"creation_date": "2018-04-26T12:42:21.619844+00:00",
"default_bootscript": {
"architecture": "x86_64",
"bootcmdargs": "LINUX_COMMON scaleway boot=local nbd.max_part=16",
"default": true,
"dtb": "",
"id": "b1e68c26-a19c-4eac-9222-498b22bd7ad9",
"initrd": "http://169.254.42.24/initrd/initrd-Linux-x86_64-v3.14.5.gz",
"kernel": "http://169.254.42.24/kernel/x86_64-mainline-lts-4.4-4.4.127-rev1/vmlinuz-4.4.127",
"organization": "11111111-1111-4111-8111-111111111111",
"public": true,
"title": "x86_64 mainline 4.4.127 rev1"
},
"extra_volumes": [],
"from_server": null,
"id": "67375eb1-f14d-4f02-bb42-6119cecbde51",
"modification_date": "2018-04-26T12:49:07.573004+00:00",
"name": "Ubuntu Xenial",
"organization": "51b656e3-4865-41e8-adbc-0c45bdd780db",
"public": true,
"root_volume": {
"id": "020b8d61-3867-4a0e-84a4-445c5393e05d",
"name": "snapshot-87fc282d-f252-4262-adad-86979d9074cf-2018-04-26_12:42",
"size": 25000000000,
"volume_type": "l_ssd"
},
"state": "available"
},
"ipv6": null,
"location": {
"cluster_id": "5",
"hypervisor_id": "412",
"node_id": "2",
"platform_id": "13",
"zone_id": "par1"
},
"maintenances": [],
"modification_date": "2018-08-14T21:37:28.630882+00:00",
"name": "scw-e0d256",
"organization": "3f709602-5e6c-4619-b80c-e841c89734af",
"private_ip": "10.14.222.131",
"protected": false,
"public_ip": {
"address": "163.172.170.197",
"dynamic": false,
"id": "ea081794-a581-4495-8451-386ddaf0a451"
},
"security_group": {
"id": "a37379d2-d8b0-4668-9cfb-1233fc436f7e",
"name": "Default security group"
},
"state": "running",
"state_detail": "booted",
"tags": [],
"volumes": {
"0": {
"creation_date": "2018-08-14T21:36:56.271545+00:00", "creation_date": "2018-08-14T21:36:56.271545+00:00",
"dynamic_ip_required": false, "export_uri": "device://dev/vda",
"enable_ipv6": false, "id": "68386fae-4f55-4fbf-aabb-953036a85872",
"extra_networks": [], "modification_date": "2018-08-14T21:36:56.271545+00:00",
"hostname": "scw-e0d256", "name": "snapshot-87fc282d-f252-4262-adad-86979d9074cf-2018-04-26_12:42",
"id": "12f19bc7-108c-4517-954c-e6b3d0311363",
"image": {
"arch": "x86_64",
"creation_date": "2018-04-26T12:42:21.619844+00:00",
"default_bootscript": {
"architecture": "x86_64",
"bootcmdargs": "LINUX_COMMON scaleway boot=local nbd.max_part=16",
"default": true,
"dtb": "",
"id": "b1e68c26-a19c-4eac-9222-498b22bd7ad9",
"initrd": "http://169.254.42.24/initrd/initrd-Linux-x86_64-v3.14.5.gz",
"kernel": "http://169.254.42.24/kernel/x86_64-mainline-lts-4.4-4.4.127-rev1/vmlinuz-4.4.127",
"organization": "11111111-1111-4111-8111-111111111111",
"public": true,
"title": "x86_64 mainline 4.4.127 rev1"
},
"extra_volumes": [],
"from_server": null,
"id": "67375eb1-f14d-4f02-bb42-6119cecbde51",
"modification_date": "2018-04-26T12:49:07.573004+00:00",
"name": "Ubuntu Xenial",
"organization": "51b656e3-4865-41e8-adbc-0c45bdd780db",
"public": true,
"root_volume": {
"id": "020b8d61-3867-4a0e-84a4-445c5393e05d",
"name": "snapshot-87fc282d-f252-4262-adad-86979d9074cf-2018-04-26_12:42",
"size": 25000000000,
"volume_type": "l_ssd"
},
"state": "available"
},
"ipv6": null,
"location": {
"cluster_id": "5",
"hypervisor_id": "412",
"node_id": "2",
"platform_id": "13",
"zone_id": "par1"
},
"maintenances": [],
"modification_date": "2018-08-14T21:37:28.630882+00:00",
"name": "scw-e0d256",
"organization": "3f709602-5e6c-4619-b80c-e841c89734af", "organization": "3f709602-5e6c-4619-b80c-e841c89734af",
"private_ip": "10.14.222.131", "server": {
"protected": false, "id": "12f19bc7-108c-4517-954c-e6b3d0311363",
"public_ip": { "name": "scw-e0d256"
"address": "163.172.170.197",
"dynamic": false,
"id": "ea081794-a581-4495-8451-386ddaf0a451"
}, },
"security_group": { "size": 25000000000,
"id": "a37379d2-d8b0-4668-9cfb-1233fc436f7e", "state": "available",
"name": "Default security group" "volume_type": "l_ssd"
}, }
"state": "running",
"state_detail": "booted",
"tags": [],
"volumes": {
"0": {
"creation_date": "2018-08-14T21:36:56.271545+00:00",
"export_uri": "device://dev/vda",
"id": "68386fae-4f55-4fbf-aabb-953036a85872",
"modification_date": "2018-08-14T21:36:56.271545+00:00",
"name": "snapshot-87fc282d-f252-4262-adad-86979d9074cf-2018-04-26_12:42",
"organization": "3f709602-5e6c-4619-b80c-e841c89734af",
"server": {
"id": "12f19bc7-108c-4517-954c-e6b3d0311363",
"name": "scw-e0d256"
},
"size": 25000000000,
"state": "available",
"volume_type": "l_ssd"
}
}
} }
}
] ]
""" """

24
plugins/modules/scaleway_snapshot_info.py
View file

@ -59,18 +59,18 @@ scaleway_snapshot_info:
sample: sample:
"scaleway_snapshot_info": [ "scaleway_snapshot_info": [
{ {
"base_volume": { "base_volume": {
"id": "68386fae-4f55-4fbf-aabb-953036a85872", "id": "68386fae-4f55-4fbf-aabb-953036a85872",
"name": "snapshot-87fc282d-f252-4262-adad-86979d9074cf-2018-04-26_12:42" "name": "snapshot-87fc282d-f252-4262-adad-86979d9074cf-2018-04-26_12:42"
}, },
"creation_date": "2018-08-14T22:34:35.299461+00:00", "creation_date": "2018-08-14T22:34:35.299461+00:00",
"id": "b61b4b03-a2e9-4da5-b5ea-e462ac0662d2", "id": "b61b4b03-a2e9-4da5-b5ea-e462ac0662d2",
"modification_date": "2018-08-14T22:34:54.520560+00:00", "modification_date": "2018-08-14T22:34:54.520560+00:00",
"name": "snapshot-87fc282d-f252-4262-adad-86979d9074cf-2018-04-26_12:42 snapshot", "name": "snapshot-87fc282d-f252-4262-adad-86979d9074cf-2018-04-26_12:42 snapshot",
"organization": "3f709602-5e6c-4619-b80c-e841c89734af", "organization": "3f709602-5e6c-4619-b80c-e841c89734af",
"size": 25000000000, "size": 25000000000,
"state": "available", "state": "available",
"volume_type": "l_ssd" "volume_type": "l_ssd"
} }
] ]
""" """

17
plugins/modules/scaleway_sshkey.py
View file

@ -71,13 +71,16 @@ EXAMPLES = r"""
RETURN = r""" RETURN = r"""
data: data:
description: This is only present when O(state=present). description: This is only present when O(state=present).
returned: when O(state=present) returned: when O(state=present)
type: dict type: dict
sample: { sample:
"ssh_public_keys": [ {
{"key": "ssh-rsa AAAA...."} "ssh_public_keys": [
] {
"key": "ssh-rsa AAAA...."
}
]
} }
""" """

13
plugins/modules/scaleway_volume.py
View file

@ -95,10 +95,11 @@ EXAMPLES = r"""
RETURN = r""" RETURN = r"""
data: data:
description: This is only present when O(state=present). description: This is only present when O(state=present).
returned: when O(state=present) returned: when O(state=present)
type: dict type: dict
sample: { sample:
{
"volume": { "volume": {
"export_uri": null, "export_uri": null,
"id": "c675f420-cfeb-48ff-ba2a-9d2a4dbe3fcd", "id": "c675f420-cfeb-48ff-ba2a-9d2a4dbe3fcd",
@ -107,8 +108,8 @@ data:
"server": null, "server": null,
"size": 10000000000, "size": 10000000000,
"volume_type": "l_ssd" "volume_type": "l_ssd"
} }
} }
""" """
from ansible_collections.community.general.plugins.module_utils.scaleway import SCALEWAY_LOCATION, scaleway_argument_spec, Scaleway from ansible_collections.community.general.plugins.module_utils.scaleway import SCALEWAY_LOCATION, scaleway_argument_spec, Scaleway

24
plugins/modules/scaleway_volume_info.py
View file

@ -58,18 +58,18 @@ scaleway_volume_info:
elements: dict elements: dict
sample: sample:
"scaleway_volume_info": [ "scaleway_volume_info": [
{ {
"creation_date": "2018-08-14T20:56:24.949660+00:00", "creation_date": "2018-08-14T20:56:24.949660+00:00",
"export_uri": null, "export_uri": null,
"id": "b8d51a06-daeb-4fef-9539-a8aea016c1ba", "id": "b8d51a06-daeb-4fef-9539-a8aea016c1ba",
"modification_date": "2018-08-14T20:56:24.949660+00:00", "modification_date": "2018-08-14T20:56:24.949660+00:00",
"name": "test-volume", "name": "test-volume",
"organization": "3f709602-5e6c-4619-b80c-e841c89734af", "organization": "3f709602-5e6c-4619-b80c-e841c89734af",
"server": null, "server": null,
"size": 50000000000, "size": 50000000000,
"state": "available", "state": "available",
"volume_type": "l_ssd" "volume_type": "l_ssd"
} }
] ]
""" """

2
plugins/modules/sl_vm.py
View file

@ -267,7 +267,7 @@ EXAMPLES = r"""
""" """
# TODO: Disabled RETURN as it is breaking the build for docs. Needs to be fixed. # TODO: Disabled RETURN as it is breaking the build for docs. Needs to be fixed.
RETURN = """# """ RETURN = """#"""
import json import json
import time import time

69
plugins/modules/snmp_facts.py
View file

@ -113,7 +113,7 @@ ansible_sysdescr:
description: A textual description of the entity. description: A textual description of the entity.
returned: success returned: success
type: str type: str
sample: Linux ubuntu-user 4.4.0-93-generic #116-Ubuntu SMP Fri Aug 11 21:17:51 UTC 2017 x86_64 sample: "Linux ubuntu-user 4.4.0-93-generic #116-Ubuntu SMP Fri Aug 11 21:17:51 UTC 2017 x86_64"
ansible_sysobjectid: ansible_sysobjectid:
description: The vendor's authoritative identification of the network management subsystem contained in the entity. description: The vendor's authoritative identification of the network management subsystem contained in the entity.
returned: success returned: success
@ -149,40 +149,41 @@ ansible_interfaces:
description: Dictionary of each network interface and its metadata. description: Dictionary of each network interface and its metadata.
returned: success returned: success
type: dict type: dict
sample: { sample:
"1": { {
"adminstatus": "up", "1": {
"description": "", "adminstatus": "up",
"ifindex": "1", "description": "",
"ipv4": [ "ifindex": "1",
{ "ipv4": [
"address": "127.0.0.1", {
"netmask": "255.0.0.0" "address": "127.0.0.1",
} "netmask": "255.0.0.0"
], }
"mac": "", ],
"mtu": "65536", "mac": "",
"name": "lo", "mtu": "65536",
"operstatus": "up", "name": "lo",
"speed": "65536" "operstatus": "up",
}, "speed": "65536"
"2": { },
"adminstatus": "up", "2": {
"description": "", "adminstatus": "up",
"ifindex": "2", "description": "",
"ipv4": [ "ifindex": "2",
{ "ipv4": [
"address": "192.168.213.128", {
"netmask": "255.255.255.0" "address": "192.168.213.128",
} "netmask": "255.255.255.0"
], }
"mac": "000a305a52a1", ],
"mtu": "1500", "mac": "000a305a52a1",
"name": "Intel Corporation 82545EM Gigabit Ethernet Controller (Copper)", "mtu": "1500",
"operstatus": "up", "name": "Intel Corporation 82545EM Gigabit Ethernet Controller (Copper)",
"speed": "1500" "operstatus": "up",
"speed": "1500"
}
} }
}
""" """
import binascii import binascii

11
plugins/modules/spotinst_aws_elastigroup.py
View file

@ -697,8 +697,15 @@ instances:
description: List of active elastigroup instances and their details. description: List of active elastigroup instances and their details.
returned: success returned: success
type: dict type: dict
sample: [{"spotInstanceRequestId": "sir-regs25zp", "instanceId": "i-09640ad8678234c", "instanceType": "m4.large", "product": "Linux/UNIX", sample:
"availabilityZone": "us-west-2b", "privateIp": "180.0.2.244", "createdAt": "2017-07-17T12:46:18.000Z", "status": "fulfilled"}] - "spotInstanceRequestId": "sir-regs25zp"
"instanceId": "i-09640ad8678234c"
"instanceType": "m4.large"
"product": "Linux/UNIX"
"availabilityZone": "us-west-2b"
"privateIp": "180.0.2.244"
"createdAt": "2017-07-17T12:46:18.000Z"
"status": "fulfilled"
group_id: group_id:
description: Created / Updated group's ID. description: Created / Updated group's ID.
returned: success returned: success

21
plugins/modules/syslogger.py
View file

@ -35,8 +35,25 @@ options:
type: str type: str
description: description:
- Set the log facility. - Set the log facility.
choices: ["kern", "user", "mail", "daemon", "auth", "lpr", "news", "uucp", "cron", "syslog", "local0", "local1", "local2", choices:
"local3", "local4", "local5", "local6", "local7"] - kern
- user
- mail
- daemon
- auth
- lpr
- news
- uucp
- cron
- syslog
- local0
- local1
- local2
- local3
- local4
- local5
- local6
- local7
default: "daemon" default: "daemon"
log_pid: log_pid:
description: description:

32
plugins/modules/systemd_info.py
View file

@ -8,8 +8,7 @@
from __future__ import absolute_import, division, print_function from __future__ import absolute_import, division, print_function
__metaclass__ = type __metaclass__ = type
DOCUMENTATION = r''' DOCUMENTATION = r"""
---
module: systemd_info module: systemd_info
short_description: Gather C(systemd) unit info short_description: Gather C(systemd) unit info
description: description:
@ -48,9 +47,9 @@ author:
extends_documentation_fragment: extends_documentation_fragment:
- community.general.attributes - community.general.attributes
- community.general.attributes.info_module - community.general.attributes.info_module
''' """
EXAMPLES = r''' EXAMPLES = r"""
--- ---
# Gather info for all systemd services, targets, sockets, mount and timer # Gather info for all systemd services, targets, sockets, mount and timer
- name: Gather all systemd unit info - name: Gather all systemd unit info
@ -84,9 +83,9 @@ EXAMPLES = r'''
extra_properties: extra_properties:
- AccuracyUSec - AccuracyUSec
register: results register: results
''' """
RETURN = r''' RETURN = r"""
units: units:
description: description:
- Dictionary of systemd unit info keyed by unit name. - Dictionary of systemd unit info keyed by unit name.
@ -170,8 +169,9 @@ units:
returned: only for C(.mount) units. returned: only for C(.mount) units.
type: str type: str
sample: / sample: /
sample: { sample:
"-.mount": { {
"-.mount": {
"activestate": "active", "activestate": "active",
"description": "Root Mount", "description": "Root Mount",
"loadstate": "loaded", "loadstate": "loaded",
@ -181,8 +181,8 @@ units:
"type": "xfs", "type": "xfs",
"what": "/dev/mapper/cs-root", "what": "/dev/mapper/cs-root",
"where": "/" "where": "/"
}, },
"sshd-keygen.target": { "sshd-keygen.target": {
"activestate": "active", "activestate": "active",
"description": "sshd-keygen.target", "description": "sshd-keygen.target",
"fragmentpath": "/usr/lib/systemd/system/sshd-keygen.target", "fragmentpath": "/usr/lib/systemd/system/sshd-keygen.target",
@ -191,8 +191,8 @@ units:
"substate": "active", "substate": "active",
"unitfilepreset": "disabled", "unitfilepreset": "disabled",
"unitfilestate": "static" "unitfilestate": "static"
}, },
"systemd-journald.service": { "systemd-journald.service": {
"activestate": "active", "activestate": "active",
"description": "Journal Service", "description": "Journal Service",
"execmainpid": "613", "execmainpid": "613",
@ -203,8 +203,8 @@ units:
"substate": "running", "substate": "running",
"unitfilepreset": "disabled", "unitfilepreset": "disabled",
"unitfilestate": "static" "unitfilestate": "static"
}, },
"systemd-journald.socket": { "systemd-journald.socket": {
"activestate": "active", "activestate": "active",
"description": "Journal Socket", "description": "Journal Socket",
"fragmentpath": "/usr/lib/systemd/system/systemd-journald.socket", "fragmentpath": "/usr/lib/systemd/system/systemd-journald.socket",
@ -213,9 +213,9 @@ units:
"substate": "running", "substate": "running",
"unitfilepreset": "disabled", "unitfilepreset": "disabled",
"unitfilestate": "static" "unitfilestate": "static"
}
} }
} """
'''
import fnmatch import fnmatch
from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.basic import AnsibleModule

2
plugins/modules/taiga_issue.py
View file

@ -119,7 +119,7 @@ EXAMPLES = r"""
state: absent state: absent
""" """
RETURN = """# """ RETURN = """#"""
import traceback import traceback
from os import getenv from os import getenv

4
plugins/modules/telegram.py
View file

@ -55,7 +55,7 @@ EXAMPLES = r"""
community.general.telegram: community.general.telegram:
token: '9999999:XXXXXXXXXXXXXXXXXXXXXXX' token: '9999999:XXXXXXXXXXXXXXXXXXXXXXX'
api_args: api_args:
chat_id: 000000 chat_id: "000000"
parse_mode: "markdown" parse_mode: "markdown"
text: "Your precious application has been deployed: https://example.com" text: "Your precious application has been deployed: https://example.com"
disable_web_page_preview: true disable_web_page_preview: true
@ -66,7 +66,7 @@ EXAMPLES = r"""
token: '9999999:XXXXXXXXXXXXXXXXXXXXXXX' token: '9999999:XXXXXXXXXXXXXXXXXXXXXXX'
api_method: forwardMessage api_method: forwardMessage
api_args: api_args:
chat_id: 000000 chat_id: "000000"
from_chat_id: 111111 from_chat_id: 111111
disable_notification: true disable_notification: true
message_id: '{{ saved_msg_id }}' message_id: '{{ saved_msg_id }}'

2
plugins/modules/udm_dns_zone.py
View file

@ -102,7 +102,7 @@ EXAMPLES = r"""
""" """
RETURN = """# """ RETURN = """#"""
from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.basic import AnsibleModule
from ansible_collections.community.general.plugins.module_utils.univention_umc import ( from ansible_collections.community.general.plugins.module_utils.univention_umc import (

2
plugins/modules/udm_group.py
View file

@ -85,7 +85,7 @@ EXAMPLES = r"""
""" """
RETURN = """# """ RETURN = """#"""
from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.basic import AnsibleModule
from ansible_collections.community.general.plugins.module_utils.univention_umc import ( from ansible_collections.community.general.plugins.module_utils.univention_umc import (

2
plugins/modules/udm_share.py
View file

@ -340,7 +340,7 @@ EXAMPLES = r"""
""" """
RETURN = """# """ RETURN = """#"""
from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.basic import AnsibleModule
from ansible_collections.community.general.plugins.module_utils.univention_umc import ( from ansible_collections.community.general.plugins.module_utils.univention_umc import (

2
plugins/modules/udm_user.py
View file

@ -317,7 +317,7 @@ EXAMPLES = r"""
""" """
RETURN = """# """ RETURN = """#"""
from datetime import date, timedelta from datetime import date, timedelta
import traceback import traceback

2
plugins/modules/vdo.py
View file

@ -220,7 +220,7 @@ EXAMPLES = r"""
state: absent state: absent
""" """
RETURN = r"""# """ RETURN = r"""#"""
from ansible.module_utils.basic import AnsibleModule, missing_required_lib from ansible.module_utils.basic import AnsibleModule, missing_required_lib
import re import re

165
plugins/modules/xenserver_guest_info.py
View file

@ -61,90 +61,91 @@ EXAMPLES = r"""
RETURN = r""" RETURN = r"""
instance: instance:
description: Metadata about the VM. description: Metadata about the VM.
returned: always returned: always
type: dict type: dict
sample: { sample:
"cdrom": { {
"type": "none" "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"
}, },
"customization_agent": "native", {
"disks": [ "name": "testvm_11-1",
{ "name_desc": "",
"name": "testvm_11-0", "os_device": "xvdb",
"name_desc": "", "size": 42949672960,
"os_device": "xvda", "sr": "Local storage",
"size": 42949672960, "sr_uuid": "0af1245e-bdb0-ba33-1446-57a962ec4075",
"sr": "Local storage", "vbd_userdevice": "1"
"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": ""
}
} }
""" """

165
plugins/modules/xenserver_guest_powerstate.py
View file

@ -88,90 +88,91 @@ EXAMPLES = r"""
RETURN = r""" RETURN = r"""
instance: instance:
description: Metadata about the VM. description: Metadata about the VM.
returned: always returned: always
type: dict type: dict
sample: { sample:
"cdrom": { {
"type": "none" "cdrom": {
"type": "none"
},
"customization_agent": "native",
"disks": [
{
"name": "windows-template-testing-0",
"name_desc": "",
"os_device": "xvda",
"size": 42949672960,
"sr": "Local storage",
"sr_uuid": "0af1245e-bdb0-ba33-1446-57a962ec4075",
"vbd_userdevice": "0"
}, },
"customization_agent": "native", {
"disks": [ "name": "windows-template-testing-1",
{ "name_desc": "",
"name": "windows-template-testing-0", "os_device": "xvdb",
"name_desc": "", "size": 42949672960,
"os_device": "xvda", "sr": "Local storage",
"size": 42949672960, "sr_uuid": "0af1245e-bdb0-ba33-1446-57a962ec4075",
"sr": "Local storage", "vbd_userdevice": "1"
"sr_uuid": "0af1245e-bdb0-ba33-1446-57a962ec4075",
"vbd_userdevice": "0"
},
{
"name": "windows-template-testing-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": "windows-template-testing",
"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": "windows-template-testing",
"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": ""
}
} }
""" """

67
plugins/modules/zfs_facts.py
View file

@ -93,16 +93,63 @@ zfs_datasets:
description: ZFS dataset facts. description: ZFS dataset facts.
returned: always returned: always
type: str type: str
sample: {"aclinherit": "restricted", "aclmode": "discard", "atime": "on", "available": "43.8G", "canmount": "on", "casesensitivity": "sensitive", sample:
"checksum": "on", "compression": "off", "compressratio": "1.00x", "copies": "1", "creation": "Thu Jun 16 11:37 2016", "aclinherit": "restricted"
"dedup": "off", "devices": "on", "exec": "on", "filesystem_count": "none", "filesystem_limit": "none", "logbias": "latency", "aclmode": "discard"
"logicalreferenced": "18.5K", "logicalused": "3.45G", "mlslabel": "none", "mounted": "yes", "mountpoint": "/rpool", "name": "rpool", "atime": "on"
"nbmand": "off", "normalization": "none", "org.openindiana.caiman:install": "ready", "primarycache": "all", "quota": "none", "available": "43.8G"
"readonly": "off", "recordsize": "128K", "redundant_metadata": "all", "refcompressratio": "1.00x", "referenced": "29.5K", "canmount": "on"
"refquota": "none", "refreservation": "none", "reservation": "none", "secondarycache": "all", "setuid": "on", "sharenfs": "off", "casesensitivity": "sensitive"
"sharesmb": "off", "snapdir": "hidden", "snapshot_count": "none", "snapshot_limit": "none", "sync": "standard", "type": "filesystem", "checksum": "on"
"used": "4.41G", "usedbychildren": "4.41G", "usedbydataset": "29.5K", "usedbyrefreservation": "0", "usedbysnapshots": "0", "compression": "off"
"utf8only": "off", "version": "5", "vscan": "off", "written": "29.5K", "xattr": "on", "zoned": "off"} "compressratio": "1.00x"
"copies": "1"
"creation": "Thu Jun 16 11:37 2016"
"dedup": "off"
"devices": "on"
"exec": "on"
"filesystem_count": "none"
"filesystem_limit": "none"
"logbias": "latency"
"logicalreferenced": "18.5K"
"logicalused": "3.45G"
"mlslabel": "none"
"mounted": "yes"
"mountpoint": "/rpool"
"name": "rpool"
"nbmand": "off"
"normalization": "none"
"org.openindiana.caiman:install": "ready"
"primarycache": "all"
"quota": "none"
"readonly": "off"
"recordsize": "128K"
"redundant_metadata": "all"
"refcompressratio": "1.00x"
"referenced": "29.5K"
"refquota": "none"
"refreservation": "none"
"reservation": "none"
"secondarycache": "all"
"setuid": "on"
"sharenfs": "off"
"sharesmb": "off"
"snapdir": "hidden"
"snapshot_count": "none"
"snapshot_limit": "none"
"sync": "standard"
"type": "filesystem"
"used": "4.41G"
"usedbychildren": "4.41G"
"usedbydataset": "29.5K"
"usedbyrefreservation": "0"
"usedbysnapshots": "0"
"utf8only": "off"
"version": "5"
"vscan": "off"
"written": "29.5K"
"xattr": "on"
"zoned": "off"
""" """
from collections import defaultdict from collections import defaultdict

14
plugins/modules/zpool.py
View file

@ -8,7 +8,7 @@
from __future__ import absolute_import, division, print_function from __future__ import absolute_import, division, print_function
__metaclass__ = type __metaclass__ = type
DOCUMENTATION = r''' DOCUMENTATION = r"""
module: zpool module: zpool
short_description: Manage ZFS zpools short_description: Manage ZFS zpools
version_added: 11.0.0 version_added: 11.0.0
@ -35,7 +35,7 @@ options:
state: state:
description: description:
- Whether the pool should exist. - Whether the pool should exist.
choices: [ present, absent ] choices: [present, absent]
default: present default: present
type: str type: str
disable_new_features: disable_new_features:
@ -80,12 +80,12 @@ options:
description: description:
- Special vdev role (for example V(log), V(cache), V(spare)). - Special vdev role (for example V(log), V(cache), V(spare)).
type: str type: str
choices: [ log, cache, spare, dedup, special ] choices: [log, cache, spare, dedup, special]
type: type:
description: description:
- Vdev topology (for example V(stripe), V(mirror), V(raidz)). - Vdev topology (for example V(stripe), V(mirror), V(raidz)).
type: str type: str
choices: [ stripe, mirror, raidz, raidz1, raidz2, raidz3 ] choices: [stripe, mirror, raidz, raidz1, raidz2, raidz3]
default: stripe default: stripe
disks: disks:
description: description:
@ -93,9 +93,9 @@ options:
required: true required: true
type: list type: list
elements: path elements: path
''' """
EXAMPLES = r''' EXAMPLES = r"""
- name: Create pool "tank" on /dev/sda - name: Create pool "tank" on /dev/sda
community.general.zpool: community.general.zpool:
name: tank name: tank
@ -137,7 +137,7 @@ EXAMPLES = r'''
community.general.zpool: community.general.zpool:
name: tank name: tank
state: absent state: absent
''' """
import re import re
from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.basic import AnsibleModule

48
plugins/modules/zpool_facts.py
View file

@ -64,14 +64,46 @@ ansible_facts:
description: ZFS pool facts. description: ZFS pool facts.
returned: always returned: always
type: str type: str
sample: {"allocated": "3.46G", "altroot": "-", "autoexpand": "off", "autoreplace": "off", "bootfs": "rpool/ROOT/openindiana", sample:
"cachefile": "-", "capacity": "6%", "comment": "-", "dedupditto": "0", "dedupratio": "1.00x", "delegation": "on", "allocated": "3.46G"
"expandsize": "-", "failmode": "wait", "feature@async_destroy": "enabled", "feature@bookmarks": "enabled", "feature@edonr": "enabled", "altroot": "-"
"feature@embedded_data": "active", "feature@empty_bpobj": "active", "feature@enabled_txg": "active", "feature@extensible_dataset": "enabled", "autoexpand": "off"
"feature@filesystem_limits": "enabled", "feature@hole_birth": "active", "feature@large_blocks": "enabled", "feature@lz4_compress": "active", "autoreplace": "off"
"feature@multi_vdev_crash_dump": "enabled", "feature@sha512": "enabled", "feature@skein": "enabled", "feature@spacemap_histogram": "active", "bootfs": "rpool/ROOT/openindiana"
"fragmentation": "3%", "free": "46.3G", "freeing": "0", "guid": "15729052870819522408", "health": "ONLINE", "leaked": "0", "cachefile": "-"
"listsnapshots": "off", "name": "rpool", "readonly": "off", "size": "49.8G", "version": "-"} "capacity": "6%"
"comment": "-"
"dedupditto": "0"
"dedupratio": "1.00x"
"delegation": "on"
"expandsize": "-"
"failmode": "wait"
"feature@async_destroy": "enabled"
"feature@bookmarks": "enabled"
"feature@edonr": "enabled"
"feature@embedded_data": "active"
"feature@empty_bpobj": "active"
"feature@enabled_txg": "active"
"feature@extensible_dataset": "enabled"
"feature@filesystem_limits": "enabled"
"feature@hole_birth": "active"
"feature@large_blocks": "enabled"
"feature@lz4_compress": "active"
"feature@multi_vdev_crash_dump": "enabled"
"feature@sha512": "enabled"
"feature@skein": "enabled"
"feature@spacemap_histogram": "active"
"fragmentation": "3%"
"free": "46.3G"
"freeing": "0"
"guid": "15729052870819522408"
"health": "ONLINE"
"leaked": "0"
"listsnapshots": "off"
"name": "rpool"
"readonly": "off"
"size": "49.8G"
"version": "-"
name: name:
description: ZFS pool name. description: ZFS pool name.
returned: always returned: always