sap.sap_operations.me_valid_alias test – Return true if string provided is valid software alias.

Note

This test plugin is part of the sap.sap_operations collection.

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install sap.sap_operations.

To use it in a playbook, specify: sap.sap_operations.me_valid_alias.

New in sap.sap_operations 1.10.0

Synopsis

  • Return true if string provided is valid software alias.

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 sap.sap_operations.me_valid_alias(key1=value1, key2=value2, ...) and input is not sap.sap_operations.me_valid_alias(key1=value1, key2=value2, ...)

Parameter

Comments

value

string / required

Value to check.

Notes

Note

  • This module is community supported

  • Module interface (parameters, output) expected to be stable but not guaranteed

  • Module planned to be released on Ansible Automation Hub after collecting some feedback

  • There is no guarantee that this module will be officially supported by Red Hat

Examples

- name: Test 'me_valid_alias' test plugin, this assertion is True
  ansible.builtin.assert:
    that: "{{ 'saphostagent' is sap.sap_operations.me_valid_alias }}"

- name: Test 'me_valid_alias' test plugin, this assertion is True
  ansible.builtin.assert:
    that: "{{ 'hana-client' is sap.sap_operations.me_valid_alias }}"

- name: Test 'me_valid_alias' test plugin, this assertion is True
  ansible.builtin.assert:
    that: "{{ 'does_not_exist' is not sap.sap_operations.me_valid_alias }}"

Return Value

Key

Description

Return value

boolean

True if value provided is valid alias.

Returned: success

Authors

  • Kirill Satarin (@kksat)

Hint

Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.