W3cubDocs

/Ansible

infinidat.infinibox.infini_sso module – Configures or queries SSO on Infinibox

Note

This module is part of the infinidat.infinibox collection (version 1.6.3).

You might already have this collection installed if you are using the ansible package. 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 infinidat.infinibox. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: infinidat.infinibox.infini_sso.

New in infinidat.infinibox 2.16.0

Synopsis
Requirements
Parameters
Notes
Examples

Synopsis

This module configures (present state) or gets information about (absent state) SSO on Infinibox

Requirements

The below requirements are needed on the host that executes this module.

python2 >= 2.7 or python3 >= 3.6
infinisdk (https://infinisdk.readthedocs.io/en/latest/)

Parameters

Parameter	Comments
enabled boolean	Determines if the SSO is enabled. Choices: `false` `true` ← (default)
issuer string	URI of the SSO issuer.
name string / required	Sets a name to reference the SSO by.
password string / required	Infinibox User password.
sign_on_url string	URL for sign on.
signed_assertion boolean	Signed assertion Choices: `false` ← (default) `true`
signed_response boolean	Signed response Choices: `false` ← (default) `true`
signing_certificate string	Signing certificate content.
state string	Creates/Modifies the SSO, when using state present. For state absent, the SSO is removed. State stat shows the existing SSO’s details. Choices: `"stat"` `"present"` ← (default) `"absent"`
stay_logged_in boolean	If True, persist API session to disk. Load the session on subsequent module calls. Persisted sessions are only usable for stay_logged_in_minutes. Choices: `false` ← (default) `true`
stay_logged_in_minutes integer	Number of minutes for which a persisted session may be reused. After this time, the session data will be deleted. The time should be shorter than the IBOX session timeout time. Default: `5`
system string / required	Infinibox Hostname or IPv4 Address.
user string / required	Infinibox User username with sufficient priveledges ( see notes ).

Notes

Note

This module requires infinisdk python library
You must set INFINIBOX_USER and INFINIBOX_PASSWORD environment variables if user and password arguments are not passed to the module directly
Ansible uses the infinisdk configuration file ~/.infinidat/infinisdk.ini if no credentials are provided. See http://infinisdk.readthedocs.io/en/latest/getting_started.html
All Infinidat modules support check mode (–check). However, a dryrun that creates resources may fail if the resource dependencies are not met for a task. For example, consider a task that creates a volume in a pool. If the pool does not exist, the volume creation task will fail. It will fail even if there was a previous task in the playbook that would have created the pool but did not because the pool creation was also part of the dry run.

Examples

- name: Configure SSO
  infini_sso:
    name: OKTA
    enabled: true
    issuer: "http://www.okta.com/eykRra384o32rrTs"
    sign_on_url: "https://infinidat.okta.com/app/infinidat_psus/exkra32oyyU6KCUCk2p7/sso/saml"
    state: present
    user: admin
    password: secret
    system: ibox001

- name: Stat SSO
  infini_sso:
    name: OKTA
    state: stat
    user: admin
    password: secret
    system: ibox001

- name: Clear SSO configuration
  infini_sso:
    state: absent
    user: admin
    password: secret
    system: ibox001

Authors

David Ohlemacher (@ohlemacher)

Collection links

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/infinidat/infinibox/infini_sso_module.html