W3cubDocs

/Ansible

infinidat.infinibox.infini_fibre_channel_switch module – Manage Infinibox FC switch names

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_fibre_channel_switch.

New in infinidat.infinibox 2.16.0

Synopsis

  • This module renames FC switch names (rename state) or shows information about FC switches (stat state)

Requirements

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

Parameters

Parameter

Comments

new_switch_name

string

New name for an existing fibre channel switch.

password

string / required

Infinibox User password.

state

string

Rename an FC switch name, when using state rename.

States present and absent are not implemented.

State stat shows the existing FC switch details.

Choices:

  • "stat"
  • "rename" ← (default)

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

switch_name

string / required

Current name of an existing fibre channel switch.

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: Rename fibre channel switch
  infini_fibre_channel:
    switch_name: VSAN 100
    state: rename
    user: admin
    password: secret
    system: ibox001

- name: Get information about fibre channel switch
  infini_fibre_channel:
    switch_name: VSAN 2000
    state: stat
    user: admin
    password: secret
    system: ibox001

Authors

  • David Ohlemacher (@ohlemacher)

© 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_fibre_channel_switch_module.html