archive
/
ansible
mirror of https://github.com/ansible/ansible.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update URLs in documentation (#67376)

Browse Source 
Partially fixes: #67357

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
pull/60051/head
Abhijeet Kasurde 5 years ago committed by GitHub
parent 6b111e46ba
commit 7dcf32294b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
11 changed files with 17 additions and 17 deletions
Show Stats Download Patch File Download Diff File

8
lib/ansible/modules/cloud/amazon/elb_target_info.py
Unescape Escape View File

@ -179,10 +179,10 @@ instance_target_groups:
sample: sample:
- us-west-2a - us-west-2a
target_health: target_health:
description: the target health description description:
(see U(https://boto3.readthedocs.io/en/latest/ - The target health description.
reference/services/elbv2.html#ElasticLoadBalancingv2.Client.describe_target_health)) - See following link for all the possible values
for all possible values U(https://boto3.readthedocs.io/en/latest/reference/services/elbv2.html#ElasticLoadBalancingv2.Client.describe_target_health)
returned: always returned: always
type: complex type: complex
contains: contains:

2
lib/ansible/modules/cloud/ovh/ovh_ip_failover.py
Unescape Escape View File

@ -24,7 +24,7 @@ author: "Pascal HERAUD (@pascalheraud)"
notes: notes:
- Uses the python OVH Api U(https://github.com/ovh/python-ovh). - Uses the python OVH Api U(https://github.com/ovh/python-ovh).
You have to create an application (a key and secret) with a consummer You have to create an application (a key and secret) with a consummer
key as described into U(https://eu.api.ovh.com/g934.first_step_with_api) key as described into U(https://docs.ovh.com/gb/en/customer/first-steps-with-ovh-api/)
requirements: requirements:
- ovh >= 0.4.8 - ovh >= 0.4.8
options: options:

2
lib/ansible/modules/cloud/ovh/ovh_ip_loadbalancing_backend.py
Unescape Escape View File

@ -23,7 +23,7 @@ author: Pascal Heraud (@pascalheraud)
notes: notes:
- Uses the python OVH Api U(https://github.com/ovh/python-ovh). - Uses the python OVH Api U(https://github.com/ovh/python-ovh).
You have to create an application (a key and secret) with a consumer You have to create an application (a key and secret) with a consumer
key as described into U(https://eu.api.ovh.com/g934.first_step_with_api) key as described into U(https://docs.ovh.com/gb/en/customer/first-steps-with-ovh-api/)
requirements: requirements:
- ovh > 0.3.5 - ovh > 0.3.5
options: options:

2
lib/ansible/modules/cloud/packet/packet_volume_attachment.py
Unescape Escape View File

@ -22,7 +22,7 @@ short_description: Attach/detach a volume to a device in the Packet host.
description: description:
- Attach/detach a volume to a device in the Packet host. - Attach/detach a volume to a device in the Packet host.
- API is documented at U(https://www.packet.net/developers/api/volumeattachments/). - API is documented at U(https://www.packet.com/developers/api/volumes/).
- "This module creates the attachment route in the Packet API. In order to discover - "This module creates the attachment route in the Packet API. In order to discover
the block devices on the server, you have to run the Attach Scripts, the block devices on the server, you have to run the Attach Scripts,
as documented at U(https://help.packet.net/technical/storage/packet-block-storage-linux)." as documented at U(https://help.packet.net/technical/storage/packet-block-storage-linux)."

6
lib/ansible/modules/cloud/xenserver/xenserver_guest.py
Unescape Escape View File

@ -28,7 +28,7 @@ notes:
- 'To acquire XenAPI Python library, just run C(pip install XenAPI) on your Ansible Control Node. The library can also be found inside - 'To acquire XenAPI Python library, just run C(pip install XenAPI) on your Ansible Control Node. The library can also be found inside
Citrix Hypervisor/XenServer SDK (downloadable from Citrix website). Copy the XenAPI.py file from the SDK to your Python site-packages on your Citrix Hypervisor/XenServer SDK (downloadable from Citrix website). Copy the XenAPI.py file from the SDK to your Python site-packages on your
Ansible Control Node to use it. Latest version of the library can also be acquired from GitHub: Ansible Control Node to use it. Latest version of the library can also be acquired from GitHub:
https://raw.githubusercontent.com/xapi-project/xen-api/master/scripts/examples/python/XenAPI.py' U(https://raw.githubusercontent.com/xapi-project/xen-api/master/scripts/examples/python/XenAPI/XenAPI.py)'
- 'If no scheme is specified in C(hostname), module defaults to C(http://) because C(https://) is problematic in most setups. Make sure you are - 'If no scheme is specified in C(hostname), module defaults to C(http://) because C(https://) is problematic in most setups. Make sure you are
accessing XenServer host in trusted environment or use C(https://) scheme explicitly.' accessing XenServer host in trusted environment or use C(https://) scheme explicitly.'
- 'To use C(https://) scheme for C(hostname) you have to either import host certificate to your OS certificate store or use C(validate_certs: no) - 'To use C(https://) scheme for C(hostname) you have to either import host certificate to your OS certificate store or use C(validate_certs: no)
@ -38,7 +38,7 @@ notes:
detect if such support is available and utilize it, else it will use a custom method of configuration via xenstore. Since XenServer Guest detect if such support is available and utilize it, else it will use a custom method of configuration via xenstore. Since XenServer Guest
agent only support None and Static types of network configuration, where None means DHCP configured interface, C(networks.type) and C(networks.type6) agent only support None and Static types of network configuration, where None means DHCP configured interface, C(networks.type) and C(networks.type6)
values C(none) and C(dhcp) have same effect. More info here: values C(none) and C(dhcp) have same effect. More info here:
https://www.citrix.com/community/citrix-developer/citrix-hypervisor-developer/citrix-hypervisor-developing-products/citrix-hypervisor-staticip.html' U(https://www.citrix.com/community/citrix-developer/citrix-hypervisor-developer/citrix-hypervisor-developing-products/citrix-hypervisor-staticip.html)'
- 'On platforms without official support for network configuration inside a guest OS, network parameters will be written to xenstore - 'On platforms without official support for network configuration inside a guest OS, network parameters will be written to xenstore
C(vm-data/networks/<vif_device>) key. Parameters can be inspected by using C(xenstore ls) and C(xenstore read) tools on \*nix guests or trough C(vm-data/networks/<vif_device>) key. Parameters can be inspected by using C(xenstore ls) and C(xenstore read) tools on \*nix guests or trough
WMI interface on Windows guests. They can also be found in VM facts C(instance.xenstore_data) key as returned by the module. It is up to the user WMI interface on Windows guests. They can also be found in VM facts C(instance.xenstore_data) key as returned by the module. It is up to the user
@ -46,7 +46,7 @@ notes:
Take note that for xenstore data to become available inside a guest, a VM restart is needed hence module will require VM restart if any Take note that for xenstore data to become available inside a guest, a VM restart is needed hence module will require VM restart if any
parameter is changed. This is a limitation of XenAPI and xenstore. Considering these limitations, network configuration trough xenstore is most parameter is changed. This is a limitation of XenAPI and xenstore. Considering these limitations, network configuration trough xenstore is most
useful for bootstraping newly deployed VMs, much less for reconfiguring existing ones. More info here: useful for bootstraping newly deployed VMs, much less for reconfiguring existing ones. More info here:
https://support.citrix.com/article/CTX226713' U(https://support.citrix.com/article/CTX226713)'
requirements: requirements:
- python >= 2.6 - python >= 2.6
- XenAPI - XenAPI

2
lib/ansible/modules/cloud/xenserver/xenserver_guest_info.py
Unescape Escape View File

@ -26,7 +26,7 @@ notes:
- 'To acquire XenAPI Python library, just run C(pip install XenAPI) on your Ansible Control Node. The library can also be found inside - 'To acquire XenAPI Python library, just run C(pip install XenAPI) on your Ansible Control Node. The library can also be found inside
Citrix Hypervisor/XenServer SDK (downloadable from Citrix website). Copy the XenAPI.py file from the SDK to your Python site-packages on your Citrix Hypervisor/XenServer SDK (downloadable from Citrix website). Copy the XenAPI.py file from the SDK to your Python site-packages on your
Ansible Control Node to use it. Latest version of the library can also be acquired from GitHub: Ansible Control Node to use it. Latest version of the library can also be acquired from GitHub:
https://raw.githubusercontent.com/xapi-project/xen-api/master/scripts/examples/python/XenAPI.py' U(https://raw.githubusercontent.com/xapi-project/xen-api/master/scripts/examples/python/XenAPI/XenAPI.py)'
- 'If no scheme is specified in C(hostname), module defaults to C(http://) because C(https://) is problematic in most setups. Make sure you are - 'If no scheme is specified in C(hostname), module defaults to C(http://) because C(https://) is problematic in most setups. Make sure you are
accessing XenServer host in trusted environment or use C(https://) scheme explicitly.' accessing XenServer host in trusted environment or use C(https://) scheme explicitly.'
- 'To use C(https://) scheme for C(hostname) you have to either import host certificate to your OS certificate store or use C(validate_certs: no) - 'To use C(https://) scheme for C(hostname) you have to either import host certificate to your OS certificate store or use C(validate_certs: no)

2
lib/ansible/modules/cloud/xenserver/xenserver_guest_powerstate.py
Unescape Escape View File

@ -26,7 +26,7 @@ notes:
- 'To acquire XenAPI Python library, just run C(pip install XenAPI) on your Ansible Control Node. The library can also be found inside - 'To acquire XenAPI Python library, just run C(pip install XenAPI) on your Ansible Control Node. The library can also be found inside
Citrix Hypervisor/XenServer SDK (downloadable from Citrix website). Copy the XenAPI.py file from the SDK to your Python site-packages on your Citrix Hypervisor/XenServer SDK (downloadable from Citrix website). Copy the XenAPI.py file from the SDK to your Python site-packages on your
Ansible Control Node to use it. Latest version of the library can also be acquired from GitHub: Ansible Control Node to use it. Latest version of the library can also be acquired from GitHub:
https://raw.githubusercontent.com/xapi-project/xen-api/master/scripts/examples/python/XenAPI.py' U(https://raw.githubusercontent.com/xapi-project/xen-api/master/scripts/examples/python/XenAPI/XenAPI.py)'
- 'If no scheme is specified in C(hostname), module defaults to C(http://) because C(https://) is problematic in most setups. Make sure you are - 'If no scheme is specified in C(hostname), module defaults to C(http://) because C(https://) is problematic in most setups. Make sure you are
accessing XenServer host in trusted environment or use C(https://) scheme explicitly.' accessing XenServer host in trusted environment or use C(https://) scheme explicitly.'
- 'To use C(https://) scheme for C(hostname) you have to either import host certificate to your OS certificate store or use C(validate_certs: no) - 'To use C(https://) scheme for C(hostname) you have to either import host certificate to your OS certificate store or use C(validate_certs: no)

4
lib/ansible/modules/identity/keycloak/keycloak_client.py
Unescape Escape View File

@ -29,7 +29,7 @@ description:
to your needs and a user having the expected roles. to your needs and a user having the expected roles.
- The names of module options are snake_cased versions of the camelCase ones found in the - The names of module options are snake_cased versions of the camelCase ones found in the
Keycloak API and its documentation at U(http://www.keycloak.org/docs-api/3.3/rest-api/). Keycloak API and its documentation at U(https://www.keycloak.org/docs-api/8.0/rest-api/index.html).
Aliases are provided so camelCased versions can be used as well. Aliases are provided so camelCased versions can be used as well.
- The Keycloak API does not always sanity check inputs e.g. you can set - The Keycloak API does not always sanity check inputs e.g. you can set
@ -295,7 +295,7 @@ options:
authorization_settings: authorization_settings:
description: description:
- a data structure defining the authorization settings for this client. For reference, - a data structure defining the authorization settings for this client. For reference,
please see the Keycloak API docs at U(http://www.keycloak.org/docs-api/3.3/rest-api/index.html#_resourceserverrepresentation). please see the Keycloak API docs at U(https://www.keycloak.org/docs-api/8.0/rest-api/index.html#_resourceserverrepresentation).
This is 'authorizationSettings' in the Keycloak REST API. This is 'authorizationSettings' in the Keycloak REST API.
aliases: aliases:
- authorizationSettings - authorizationSettings

2
lib/ansible/modules/identity/keycloak/keycloak_clienttemplate.py
Unescape Escape View File

@ -29,7 +29,7 @@ description:
to your needs and a user having the expected roles. to your needs and a user having the expected roles.
- The names of module options are snake_cased versions of the camelCase ones found in the - The names of module options are snake_cased versions of the camelCase ones found in the
Keycloak API and its documentation at U(http://www.keycloak.org/docs-api/3.3/rest-api/) Keycloak API and its documentation at U(https://www.keycloak.org/docs-api/8.0/rest-api/index.html)
- The Keycloak API does not always enforce for only sensible settings to be used -- you can set - The Keycloak API does not always enforce for only sensible settings to be used -- you can set
SAML-specific settings on an OpenID Connect client for instance and vice versa. Be careful. SAML-specific settings on an OpenID Connect client for instance and vice versa. Be careful.

2
lib/ansible/modules/identity/keycloak/keycloak_group.py
Unescape Escape View File

@ -27,7 +27,7 @@ description:
to your needs and a user having the expected roles. to your needs and a user having the expected roles.
- The names of module options are snake_cased versions of the camelCase ones found in the - The names of module options are snake_cased versions of the camelCase ones found in the
Keycloak API and its documentation at U(http://www.keycloak.org/docs-api/3.3/rest-api/). Keycloak API and its documentation at U(https://www.keycloak.org/docs-api/8.0/rest-api/index.html).
- Attributes are multi-valued in the Keycloak API. All attributes are lists of individual values and will - Attributes are multi-valued in the Keycloak API. All attributes are lists of individual values and will
be returned that way by this module. You may pass single values for attributes when calling the module, be returned that way by this module. You may pass single values for attributes when calling the module,

2
lib/ansible/plugins/lookup/laps_password.py
Unescape Escape View File

@ -125,7 +125,7 @@ notes:
be sent in plaintext. be sent in plaintext.
- Some scenarios may not work when running on a host with an older OpenLDAP install like MacOS. It is recommended to - Some scenarios may not work when running on a host with an older OpenLDAP install like MacOS. It is recommended to
install the latest OpenLDAP version and build python-ldap against this, see install the latest OpenLDAP version and build python-ldap against this, see
U(https://keathmilligan.net/python-ldap-and-macos/) for more information. U(https://keathmilligan.net/python-ldap-and-macos) for more information.
""" """
EXAMPLES = """ EXAMPLES = """

Write Preview
Loading…
Cancel
Save