File: //lib/python3.9/site-packages/ansible/plugins/test/url.yml
DOCUMENTATION:
name: url
author: Ansible Core
version_added: "2.14"
short_description: is the string a valid URL
description:
- Validates a string to conform to the URL standard.
options:
_input:
description: Possible URL.
type: string
required: True
schemes:
description: Subset of URI schemas to validate against, otherwise B(any) scheme is considered valid.
type: list
elements: string
EXAMPLES: |
# simple URL
{{ 'http://example.com' is url }}
# looking only for file transfers URIs
{{ 'mailto://[email protected]' is not uri(schemes=['ftp', 'ftps', 'sftp', 'file']) }}
# but it is according to standard
{{ 'mailto://[email protected]' is not uri }}
# more complex URL
{{ 'ftp://admin:[email protected]/path/to/myfile.yml' is url }}
RETURN:
_value:
description: Returns C(false) if the string is not a URL, C(true) otherwise.
type: boolean