summaryrefslogtreecommitdiffstats
path: root/lib/ansible/plugins/test/url.yml
diff options
context:
space:
mode:
Diffstat (limited to 'lib/ansible/plugins/test/url.yml')
-rw-r--r--lib/ansible/plugins/test/url.yml29
1 files changed, 29 insertions, 0 deletions
diff --git a/lib/ansible/plugins/test/url.yml b/lib/ansible/plugins/test/url.yml
new file mode 100644
index 0000000..36b6c77
--- /dev/null
+++ b/lib/ansible/plugins/test/url.yml
@@ -0,0 +1,29 @@
+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://nowone@example.com' is not uri(schemes=['ftp', 'ftps', 'sftp', 'file']) }}
+ # but it is according to standard
+ {{ 'mailto://nowone@example.com' is not uri }}
+ # more complex URL
+ {{ 'ftp://admin:secret@example.com/path/to/myfile.yml' is url }}
+RETURN:
+ _value:
+ description: Returns C(false) if the string is not a URL, C(true) otherwise.
+ type: boolean