scale_computing.hypercore.virtual_disk_info module – List virtual disks on HyperCore API

Note

This module is part of the scale_computing.hypercore collection (version 1.6.0).

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 scale_computing.hypercore.

To use it in a playbook, specify: scale_computing.hypercore.virtual_disk_info.

New in scale_computing.hypercore 1.2.0

Synopsis

  • Use this module to list virtual disk on a HyperCore server.

Parameters

Parameter

Comments

cluster_instance

dictionary

Scale Computing HyperCore instance information.

auth_method

string

Select login method. If not set, the value of the SC_AUTH_METHOD environment variable will be used.

Value local - username/password is verified by the HyperCore server (the local users).

Value oidc - username/password is verified by the configured OIDC provider.

Choices:

  • "local" ← (default)

  • "oidc"

host

string / required

The HyperCore instance URL.

If not set, the value of the SC_HOST environment variable will be used.

For example “https://10.1.2.3:443”.

password

string / required

Password used for authentication.

If not set, the value of the SC_PASSWORD environment variable will be used.

timeout

float

Timeout in seconds for the connection with the Scale Computing HyperCore API instance.

If not set, the value of the SC_TIMEOUT environment variable will be used.

username

string / required

Username used for authentication.

If not set, the value of the SC_USERNAME environment variable will be used.

name

string

Virtual disk name.

If specified, the virtual disk with that specific name will get returned.

Otherwise, all virtual disks are going to get listed.

Examples

- name: List all virtual disks
  scale_computing.hypercore.virtual_disk_info:

- name: List a single virtual disk
  scale_computing.hypercore.virtual_disk_info:
    name: demo-virtual-disk

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

records

list / elements=dictionary

A list of virtual_disk records.

Returned: success

block_size

integer

Size of individual blocks (the smallest unit of measurement for VSDs) on the drive, in bytes

Returned: success

Sample: 1048576

name

string

Name identifier

Returned: success

Sample: "demo-virtual-disk"

replication_factor

integer

How many copies of each block are stored on physical drives

Returned: success

Sample: 2

size

integer

Total capacity, in bytes

Returned: success

Sample: 1073741824

uuid

string

Unique identifier

Returned: success

Sample: "7983b298-c37a-4c99-8dfe-b2952e81b092"

Authors

  • Justin Cinkelj (@justinc1)