ansible.builtin.url test – is the string a valid URL
Note
This test plugin is part of ansible-core
and included in all Ansible
installations. In most cases, you can use the short
plugin name
url
even without specifying the collections:
keyword.
However, we recommend you use the FQCN for easy linking to the
plugin documentation and to avoid conflicting with other collections that may have
the same test plugin name.
New in ansible-core 2.14
Synopsis
Validates a string to conform to the URL standard.
Input
This describes the input of the test, the value before is ansible.builtin.url
or is not ansible.builtin.url
.
Parameter |
Comments |
---|---|
Possible URL. |
Keyword parameters
This describes keyword parameters of the test. These are the values key1=value1
, key2=value2
and so on in the following examples: input is ansible.builtin.url(key1=value1, key2=value2, ...)
and input is not ansible.builtin.url(key1=value1, key2=value2, ...)
.
Parameter |
Comments |
---|---|
Subset of URI schemas to validate against, otherwise any scheme is considered valid. |
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
Key |
Description |
---|---|
Returns Returned: success |