pyds8k.resources.ds8k.v1.common package

Submodules

pyds8k.resources.ds8k.v1.common.mixins module

class pyds8k.resources.ds8k.v1.common.mixins.FCPortMixin

Bases: object

get_ioport(port_id)

Get An IO Port for the Caller Object.

Parameters

port_id (str) – Required. id of the IO Port.

Returns

pyds8k.resources.ds8k.v1.ioports.IOPort.

Return type

object

get_ioports(port_id=None)

Get IO Ports for the Caller Object.

Parameters

port_id (str) – id of the IO Port. Get all if None.

Returns

A list of pyds8k.resources.ds8k.v1.ioports.IOPort.

Return type

list

class pyds8k.resources.ds8k.v1.common.mixins.FlashCopyMixin

Bases: object

get_cs_flashcopies(fcid=None)

Get Copy Service Flash Copies for the Caller Object.

Parameters

fcid (str) – id of the flash copy. Get all if None.

Returns

A list of pyds8k.resources.ds8k.v1.cs.flashcopies.FlashCopy.

Return type

list

get_cs_flashcopy(fcid)

Get A Copy Service Flash Copies for the Caller Object.

Parameters

fcid (str) – Required. id of the flash copy.

Returns

pyds8k.resources.ds8k.v1.cs.flashcopies.FlashCopy.

Return type

object

get_flashcopies(fcid=None)

Get Flash Copies for the Caller Object.

Parameters

fcid (str) – id of the flash copy. Get all if None.

Returns

A list of pyds8k.resources.ds8k.v1.flashcopy.FlashCopy.

Return type

list

get_flashcopy(fcid)

Get A Flash Copies for the Caller Object.

Parameters

fcid (str) – Required. id of the flash copy.

Returns

pyds8k.resources.ds8k.v1.flashcopy.FlashCopy.

Return type

object

class pyds8k.resources.ds8k.v1.common.mixins.HostPortMixin

Bases: object

get_host_port(port_id)

Get An Host Ports for the Caller Object.

Parameters

port_id (str) – id of the Host Port. Get all if None.

Returns

pyds8k.resources.ds8k.v1.host_ports.HostPort.

Return type

object

get_host_ports(port_id=None)

Get Host Ports for the Caller Object.

Parameters

port_id (str) – id of the Host Port. Get all if None.

Returns

A list of pyds8k.resources.ds8k.v1.host_ports.HostPort.

Return type

list

class pyds8k.resources.ds8k.v1.common.mixins.PPRCMixin

Bases: object

get_cs_pprc(pprc_id)

Get A Copy Service PPRC for the Caller Object.

Parameters

pprc_id (str) – Required. id of the PPRC.

Returns

pyds8k.resources.ds8k.v1.cs.pprcs.PPRC.

Return type

object

get_cs_pprcs(pprc_id=None)

Get Copy Service PPRC for the Caller Object.

Parameters

pprc_id (str) – id of the PPRC. Get all if None.

Returns

A list of pyds8k.resources.ds8k.v1.cs.pprcs.PPRC.

Return type

list

get_pprc(pprc_id=None)

Get PPRC for the Caller Object.

Parameters

pprc_id (str) – id of the PPRC. Get all if None.

Returns

A list of pyds8k.resources.ds8k.v1.pprc.PPRC.

Return type

list

class pyds8k.resources.ds8k.v1.common.mixins.RootBaseMixin

Bases: object

class pyds8k.resources.ds8k.v1.common.mixins.RootEncryptionGroupMixin

Bases: object

get_encryption_group(group_id)

Get An Encryption Groups.

Parameters

group_id (str) – Required. id of the target Encryption Group.

Returns

pyds8k.resources.ds8k.v1.encryption_groups.EncryptionGroup.

Return type

object

get_encryption_groups(group_id=None)

Get Encryption Groups.

Parameters

group_id (str) – id of the target Encryption Group. Get all if none.

Returns

A list of pyds8k.resources.ds8k.v1.encryption_groups.EncryptionGroup.

Return type

list

class pyds8k.resources.ds8k.v1.common.mixins.RootEventMixin

Bases: object

get_event(evt_id)

Get An Event.

Parameters

evt_id (str) – Required. id of the event.

Returns

pyds8k.resources.ds8k.v1.events.Event.

Return type

object

get_events(evt_id=None, evt_filter=None)

Get Events.

Parameters

• evt_id (str) – id of the event. Get all if None.

• evt_filter (dict) – predefined filters. Default is {}.

Returns

A list of pyds8k.resources.ds8k.v1.events.Event.

Return type

list

get_events_by_filter(warning=None, error=None, info=None, before=None, after=None)

Get Events by filters.

Parameters

• warning (bool) – True or False

• error (bool) – True or False

• info (bool) – True or False

• before (datetime) – timestamp of the end of the time window.

• after (datetime) – timestamp of the start of the time window.

Returns

A list of pyds8k.resources.ds8k.v1.events.Event.

Return type

list

class pyds8k.resources.ds8k.v1.common.mixins.RootFlashCopyMixin

Bases: object

create_cs_flashcopy(volume_pairs, options=None)

Create Copy Service FlashCopy

Parameters

• volume_pairs (list) –

• [{"source_volume" – 0000,”target_volume”: 1100},..]

• options (list) – Options. Default is [].

Returns

pyds8k.resources.ds8k.v1.cs.flashcopies.FlashCopy.

Return type

object

delete_cs_flashcopy(flashcopy_id)

Delete A Copy Service Flash Copy(R8).

Parameters

flashcopy_id (str) – Required. id of the target flash copy.

Returns

A tuple of DS8000 RESTAPI server response.

Return type

tuple

get_cs_flashcopies(fcid=None)

Get Copy Service Flash Copies(R8). :param fcid: id of the flash copy. Get all if None. :type fcid: str

Returns

A list of pyds8k.resources.ds8k.v1.cs.flashcopies.FlashCopy.

Return type

list

get_cs_flashcopy(fcid=None)

Get A Copy Service Flash Copy(R8). :param fcid: Required. id of the flash copy. :type fcid: str

Returns

pyds8k.resources.ds8k.v1.cs.flashcopies.FlashCopy.

Return type

object

get_flashcopies(volume_id=None)

Get Flash Copies. Deprecated after R8.

Parameters

volume_id (str) – id of the associating volume. Get all if None.

Returns

A list of pyds8k.resources.ds8k.v1.flashcopy.FlashCopy.

Return type

list

get_flashcopies_by_volume(volume_id)

Get Flash Copies by volume id. Deprecated after R8.

Parameters

volume_id (str) – Required. id of the target volume.

Returns

A list of pyds8k.resources.ds8k.v1.flashcopy.FlashCopy.

Return type

list

get_flashcopy(volume_id=None)

Get A Flash Copy. Deprecated after R8.

Parameters

volume_id (str) – Required. id of the associating volume.

Returns

pyds8k.resources.ds8k.v1.flashcopy.FlashCopy.

Return type

object

class pyds8k.resources.ds8k.v1.common.mixins.RootHMCMixin

Bases: object

create_hmc_csr(O=None, OU=None, C=None, ST=None, L=None, email=None, force=True)

Create a Certificate Signing Request

for the Hardware Management Console

Parameters

• O (str) – Optional. The name of your organization or company.

• None. (organization. Defaults to) –

• OU (str) – Optional. A department name within your organization.

• None. –

• C (str) – Optional. The two-letter ISO code for the country

• None. –

• ST (str) – Optional. The state or province where your organization

• None. –

• L (str) – Optional. The city or town where your organization is

• None. –

• email (str) – Optional. An email contact address within your

• None. –

• force (bool) – Optional. Force the creation of a new CSR if one is

• to (already in progress. Set to False if you want the CSR creation) –

• True. (fail if a CSR currently exists. Defaults to) –

Returns

The PEM formatted CSR.

Return type

str

create_hmc_selfsigned_certificate(O=None, OU=None, C=None, ST=None, L=None, days=365, email=None, restart=False)

Create a Self-signed Certificate for the Hardware Management Console

Parameters

• O (str) – Optional. The name of your organization or company.

• None. (organization. Defaults to) –

• OU (str) – Optional. A department name within your organization.

• None. –

• C (str) – Optional. The two-letter ISO code for the country

• None. –

• ST (str) – Optional. The state or province where your organization

• None. –

• L (str) – Optional. The city or town where your organization is

• None. –

• days (int) – Optional. The number of days the certificate is valid.

• 365. (Defaults to) –

• email (str) – Optional. An email contact address within your

• None. –

• restart (bool) – Optional. Restart the HMC to activate the

• True. (certificate. Defaults to) –

Returns

tuple of HTTP Response and DS8000 server message.

Return type

tuple

restart_hmc()

Restart the Hardware Management Console.

Returns

tuple of HTTP Response and DS8000 server message.

Return type

tuple

upload_hmc_signed_certificate(certificate)

Upload a Signed Certificate to the Hardware Management Console

Parameters

• certificate (str) – The opened signed certificate file or text

• string. –

Returns

tuple of HTTP Response and DS8000 server message.

Return type

tuple

class pyds8k.resources.ds8k.v1.common.mixins.RootHostMixin

Bases: object

create_host(host_name, hosttype)

Create A Host.

Parameters

• host_name (str) – Required. name of the host.

• hosttype (str) – Required. type of the host.

Returns

pyds8k.resources.ds8k.v1.hosts.Host.

Return type

object

delete_host(host_name)

Delete a host by name.

Parameters

host_name (str) – Required. name of the host.

Returns

tuple of DS8000 Server Response.

Return type

tuple

get_host(host_name)

Get A Host.

Parameters

host_name (str) – Required. name of the target host.

Returns

pyds8k.resources.ds8k.v1.hosts.Host.

Return type

object

get_host_ports_by_host(host_name)

Get Host Ports by the name of the Host.

Parameters

host_name (str) – Required. name of the host.

Returns

A list of pyds8k.resources.ds8k.v1.host_ports.HostPort.

Return type

list

get_hosts(host_name=None)

Get Hosts.

Parameters

host_name (str) – name of the target host. Get all if None.

Returns

A list of pyds8k.resources.ds8k.v1.hosts.Host.

Return type

list

get_ioports_by_host(host_name)

Get IO Ports by the name of the Host. :param host_name: Required. name of the host. :type host_name: str

Returns

A list of pyds8k.resources.ds8k.v1.ioports.IOPort.

Return type

list

get_mapping_by_host(host_name, lunid)

Get the Volume Mapping by the name of the host and the id of the volume.

Parameters

• host_name (str) – Required. name of the host.

• lunid (str) – Required. id of the volume.

Returns

pyds8k.resources.ds8k.v1.mappings.Volmap.

Return type

object

get_mappings_by_host(host_name)

Get Volume Mappings by the name fo the Host.

Parameters

host_name (str) – Required. name of the host.

Returns

A list of pyds8k.resources.ds8k.v1.mappings.Volmap.

Return type

list

get_volumes_by_host(host_name)

Get Volumes by the name of the Host.

Parameters

host_name (str) – Required. name of the host.

Returns

A list of pyds8k.resources.ds8k.v1.volumes.Volume.

Return type

list

map_volume_to_host(host_name, volume_id, lunid='')

unmap_volume_from_host(host_name, lunid)

update_host_add_ioports_all(host_name)

update_host_rm_ioports_all(host_name)

class pyds8k.resources.ds8k.v1.common.mixins.RootHostPortMixin

Bases: object

create_host_port(port_id, host_name)

Create A Host Port.

Parameters

• port_id (str) – Required. wwpn of the port.

• host_name (str) – Required. name of the host.

Returns

pyds8k.resources.ds8k.v1.host_ports.HostPort.

Return type

object

delete_host_port(port_id)

Delete A Host Port.

Parameters

port_id (str) – Required. id of the target host port.

Returns

A tuple of HTTP Response and DS8000 server message.

Return type

tuple

get_host_port(port_id)

Get A Host Port. :param port_id: Required. id of the target host port. :type port_id: str

Returns

pyds8k.resources.ds8k.v1.host_ports.HostPort.

Return type

object

get_host_ports(port_id=None)

Get Host Ports.

Parameters

port_id (str) – id of the target host port. Get all if None.

Returns

A list of pyds8k.resources.ds8k.v1.host_ports.HostPort.

Return type

list

update_host_port_change_host(port_id, host_name)

Change Port to another Host.

Parameters

• port_id (str) – Required. id of the host port.

• () (host_name) – Required. name of the new host.

Returns

pyds8k.resources.ds8k.v1.host_ports.HostPort.

Return type

object

class pyds8k.resources.ds8k.v1.common.mixins.RootIOEnclosureMixin

Bases: object

get_io_enclosure(enclosure_id)

Get an IO Enclosure.

Parameters

enclosure_id (str) – Required. id of the target IO Enclosure.

Returns

pyds8k.resources.ds8k.v1.io_enclosures.IOEnclosure.

Return type

object

get_io_enclosures(enclosure_id=None)

Get IO Enclosures.

Parameters

enclosure_id (str) – id of the target IO Enclosure. Get all if none.

Returns

A list of pyds8k.resources.ds8k.v1.io_enclosures.IOEnclosure.

Return type

list

class pyds8k.resources.ds8k.v1.common.mixins.RootIOPortMixin

Bases: object

get_ioport(port_id)

Get an IO Port.

Parameters

port_id (str) – Required. id of the target IO port.

Returns

pyds8k.resources.ds8k.v1.ioports.IOPort.

Return type

object

get_ioports(port_id=None)

Get IO Ports

Parameters

port_id (str) – id of the target IO port. Get all if none.

Returns

A list of pyds8k.resources.ds8k.v1.ioports.IOPort.

Return type

list

class pyds8k.resources.ds8k.v1.common.mixins.RootLSSMixin

Bases: object

create_lss_ckd(lss_id=None, lss_type='ckd', lcu_type='3990-6', ss_id=None)

Create CKD LSS

Parameters

• lss_id (str) – Required. id of the lss to be created.

• lss_type (str) – ‘ckd’, optional

• lcu_type (str) – valid types are 3990-3, 3990-6, 3990-tpf, bs2000

• ss_id (str) – associated subsystem id

Returns

A list of pyds8k.resources.ds8k.v1.lss.LSS.

Return type

list

delete_lss_by_id(lss_id)

Delete an LSS.

Parameters

lss_id (str) – Require. id of lss to be deleted.

Returns

tuple of HTTP Response and DS8000 server message.

Return type

tuple

get_lss(lss_id=None, lss_type='')

Get LSS

Parameters

• lss_id (str) – id of the target LSS. Get all if None.

• lss_type (str) – type of the target LSS.

Returns

A list of pyds8k.resources.ds8k.v1.lss.LSS.

Return type

list

get_lss_by_id(lss_id)

Get LSS by id

Parameters

lss_id (str) – Required. id of the target LSS.

Returns

pyds8k.resources.ds8k.v1.lss.LSS.

Return type

object

get_volumes_by_lss(lss_id)

Get Volumes by id of the LSS

Parameters

lss_id (str) – Required. id of the LSS.

Returns

A list of pyds8k.resources.ds8k.v1.volumes.Volume.

Return type

list

class pyds8k.resources.ds8k.v1.common.mixins.RootMarrayMixin

Bases: object

get_marray(marray_id)

Get a managed array.

Parameters

marray_id (str) – Required. id of the target managed array.

Returns

pyds8k.resources.ds8k.v1.marrays.Marray.

Return type

object

get_marrays(marray_id=None)

Get managed arrays

Parameters

marray_id (str) – id of the target managed array, get all if none

Returns

the list of pyds8k.resources.ds8k.v1.marrays.Marray.

Return type

list

class pyds8k.resources.ds8k.v1.common.mixins.RootNodeMixin

Bases: object

get_node(node_id)

Get a node by id

Parameters

node_id (str) – id of the node to get.

Returns

pyds8k.resources.ds8k.v1.nodes.Node.

Return type

object

get_nodes(node_id=None)

Get nodes

Parameters

node_id (str) – get the node by id or all nodes if no id specified.

Returns

A list of pyds8k.resources.ds8k.v1.nodes.Node.

Return type

list

class pyds8k.resources.ds8k.v1.common.mixins.RootPPRCMixin

Bases: object

get_cs_pprc(pprc_id)

Get A Copy Service PPRCs(R8).

Parameters

pprc_id (str) – Required. id of the PPRC.

Returns

pyds8k.resources.ds8k.v1.cs.pprcs.PPRC.

Return type

object

get_cs_pprcs(pprc_id=None)

Get Copy Service PPRCs(R8).

Parameters

pprc_id (str) – id of the PPRC. Get all if None.

Returns

A list of pyds8k.resources.ds8k.v1.cs.pprcs.PPRC.

Return type

list

get_pprc(pprc_id=None)

Get PPRC.

Parameters

pprc_id (str) – id of the PPRC. Get all if None.

Returns

A list of pyds8k.resources.ds8k.v1.pprc.PPRC.

Return type

list

get_pprc_by_volume(volume_id)

Get PPRC for a Volume by volume id.

Parameters

volume_id (str) – Required. id of the target volume.

Returns

A list of pyds8k.resources.ds8k.v1.pprc.PPRC.

Return type

list

class pyds8k.resources.ds8k.v1.common.mixins.RootPoolMixin

Bases: object

delete_eserep_by_pool(pool_id)

delete_tserep_by_pool(pool_id)

get_eserep_by_pool(pool_id)

get_pool(pool_id)

Get Extent Pool

Parameters

pool_id (str) – Required. id of the target extent pool.

Returns

pyds8k.resources.ds8k.v1.pools.Pool.

Return type

object

get_pools(pool_id=None)

Get Extent Pools

Parameters

pool_id (str) – id of the target extent pool. Get all if none.

Returns

A list of pyds8k.resources.ds8k.v1.pools.Pool.

Return type

list

get_tserep_by_pool(pool_id)

get_volumes_by_pool(pool_id)

Get volumes of a pool by the pool id.

Parameters

pool_id (str) – id of the target extent pool.

Returns

A list of pyds8k.resources.ds8k.v1.volumes.Volume.

Return type

list

update_eserep_cap_by_pool(pool_id, cap, captype='')

update_eserep_threshold_by_pool(pool_id, threshold)

update_tserep_cap_by_pool(pool_id, cap, captype='')

update_tserep_threshold_by_pool(pool_id, threshold)

class pyds8k.resources.ds8k.v1.common.mixins.RootResourceGroupMixin

Bases: object

create_resource_group(label, name='', resource_group_id='')

Create one Resource Group

Parameters

• label (str) – Required. The label for the resource group to be created.

• name (str) – The name for the resource group to be created.

• resource_group_id (str) – The resource group id to be created.

Returns

pyds8k.resources.ds8k.v1.resource_groups.ResourceGroup.

Return type

object

delete_resource_group(resource_group_id)

Delete a Resource Group

Parameters

resource_group_id (str) – Required. id of the target resource group.

Returns

tuple of DS8000 Server Response.

Return type

tuple

get_resource_group(resource_group_id)

Get a Resource Group

Parameters

resource_group_id (str) – Required. id of the target resource group.

Returns

pyds8k.resources.ds8k.v1.resource_groups.ResourceGroup.

Return type

object

get_resource_groups(resource_group_id=None)

Get Resource Groups

Parameters

resource_group_id (str) – id of the target resource group. Get all if none.

Returns

A list of pyds8k.resources.ds8k.v1.resource_groups.ResourceGroup.

Return type

list

update_resource_group(resource_group_id, label='', name='', cs_global='', pass_global='', gm_masters='', gm_sessions='')

Update one Resource Group

Parameters

• resource_group_id (str) – Required. The resource group id to be updated.

• label (str) – The label to assign to the resource group.

• name (str) – The name to assign to the resource group.

• cs_global (str) – The resource group label to associate with the Copy Services Global Resource Scope.

• pass_global (str) – The resource group label to associate with the Pass-thru Global Copy Services Resource Scope.

• gm_masters (list) – An list of Global Mirror session IDs allowed to be used as a master session for volumes in this resource.

• gm_sessions (list) – A list of Global Mirror session IDs allowed to be used for the volumes in this resource.

Returns

tuple of DS8000 Server Response.

Return type

tuple

class pyds8k.resources.ds8k.v1.common.mixins.RootResourceMixin

Bases: RootSystemMixin, RootHMCMixin, RootFlashCopyMixin, RootPPRCMixin, RootNodeMixin, RootMarrayMixin, RootUserMixin, RootIOEnclosureMixin, RootEncryptionGroupMixin, RootEventMixin, RootPoolMixin, RootResourceGroupMixin, RootVolumeMixin, RootLSSMixin, RootIOPortMixin, RootHostPortMixin, RootHostMixin, RootBaseMixin

class pyds8k.resources.ds8k.v1.common.mixins.RootSystemMixin

Bases: object

get_systems()

Get DS8000 System Object

Returns

A list of pyds8k.resources.ds8k.v1.systems.System.

Return type

list

class pyds8k.resources.ds8k.v1.common.mixins.RootUserMixin

Bases: object

get_user(user_name)

Get a user.

Parameters

user_name (str) – Required. the name of the target user.

Returns

pyds8k.resources.ds8k.v1.users.User.

Return type

object

get_users(user_name=None)

Get users.

Parameters

user_name (str) – name of the target user. get all if none.

Returns

A list of pyds8k.resources.ds8k.v1.users.User.

Return type

list

class pyds8k.resources.ds8k.v1.common.mixins.RootVolumeMixin

Bases: object

create_alias_volumes(id, ckd_base_ids, quantity='', alias_create_order='decrement')

Create ckd alias volumes for a list of base ckd volumes

Parameters

• id (str) – the starting volume id for where aliases should be created

• ckd_base_ids (list) – list of ckd base ids aliases will be created for

• quantity (str) – number of aliases per ckd base id to create, number in str

• alias_create_order (str) – whether to increment or decrement from starting id default decrement

Returns

A list of pyds8k.resources.ds8k.v1.volumes.Volume.

Return type

list

create_volume(name, cap, pool, stgtype='fb', captype='gib', lss='', tp='', id='')

Create One Volume

Parameters

• name (str) – Required. The name for the volume to be created

• cap (str) – Required. The capacity, number in str

• pool (str) – Required. The pool for the volume

• stgtype (str) – select from types.DS8K_VOLUME_TYPES, Default to 'fb'

• captype (str) – select from types.DS8K_CAPTYPES, Default to 'gib'

• lss (str) – logical subsystem id

• tp (str) – storage allocation method, valid options include none, ese, tse

• id (str) – volume id to be created

Returns

pyds8k.resources.ds8k.v1.volumes.Volume.

Return type

object

create_volume_ckd(name, cap, pool, captype='', lss='', tp='', id='')

Create One CKD Volume

Parameters

• name (str) – Required. The name for the volume to be created

• cap (str) – Required. The capacity, number in str

• pool (str) – Required. The pool for the volume

• captype (str) – select from types.DS8K_CAPTYPES, Default to 'gib'

• lss (str) – logical subsystem id

• tp (str) – storage allocation method, valid options include none, ese, tse

• id (str) – volume id to be created

Returns

A list of pyds8k.resources.ds8k.v1.volumes.Volume.

Return type

list

create_volume_fb(name, cap, pool, captype='', lss='', tp='', id='')

Create One FB Volume

Parameters

• name (str) – Required. The name for the volume to be created

• cap (str) – Required. The capacity, number in str

• pool (str) – Required. The pool for the volume

• captype (str) – select from types.DS8K_CAPTYPES, Default to 'gib'

• lss (str) – logical subsystem id

• tp (str) – storage allocation method, valid options include none, ese, tse

• id (str) – volume id to be created

Returns

A list of pyds8k.resources.ds8k.v1.volumes.Volume.

Return type

list

create_volumes(name_col, cap, pool, name='', quantity='', stgtype='fb', captype='gib', lss='', tp='', ids=None)

Create a group of volumes with different names

Parameters

• name_col (list) – [“name-1”, “name-2”,…, “name-N”]

• cap (str) – the capacity, number in str

• pool (str) – the pool for the volume

• name (str) – Either 1) Name of the volume to be created, or 2) Prefix of the <quantity> volumes to be created

• quantity (str) – number of volumes to create, number in str

• stgtype (str) – select from types.DS8K_VOLUME_TYPES, default to 'fb'

• captype (str) – select from types.DS8K_CAPTYPES, default to 'gib'

• lss (str) – logical subsystem id

• tp (str) – storage allocation method, in none, ese, tse

• ids (list) – list of volume ids to be created.

Returns

A list of pyds8k.resources.ds8k.v1.volumes.Volume.

Return type

list

create_volumes_with_names(names, cap, pool, stgtype='fb', captype='gib', lss='', tp='', ids=None)

Create a group of volumes with specified names

Parameters

• names (str) – [“name-1”, “name-2”,…, “name-N”]

• cap (str) – the capacity, number in str

• pool (str) – the pool for the volume

• stgtype (str) – select from types.DS8K_VOLUME_TYPES, default to 'fb'

• captype (str) – select from types.DS8K_CAPTYPES, default to 'gib'

• lss (str) – logical subsystem id

• tp (str) – storage allocation method, in none, ese, tse

• ids (list) – list of volume ids to be created

Returns

A list of pyds8k.resources.ds8k.v1.volumes.Volume.

Return type

list

create_volumes_with_same_prefix(name, cap, pool, quantity='', stgtype='fb', captype='gib', lss='', tp='', ids=None)

Create a volume with a name or a group of volumes with the same prefix

Parameters

• name (str) – 1, Name of the volume to be created, or 2. Prefix of the <quantity> volumes to be created

• cap (str) – the capacity, number in str

• pool (str) – the pool for the volume

• quantity (str) – number of volumes to create, number in str

• stgtype (str) – select from types.DS8K_VOLUME_TYPES, default to 'fb'

• captype (str) – select from types.DS8K_CAPTYPES, default to 'gib'

• lss (str) – logical subsystem id

• tp (str) – storage allocation method, in none, ese, tse

• ids (list) – list of volume ids to be created

Returns

A list of pyds8k.resources.ds8k.v1.volumes.Volume.

Return type

list

create_volumes_without_same_prefix(name_col, cap, pool, stgtype='fb', captype='gib', lss='', tp='', ids=None)

Create a group of volumes with specified names

Parameters

• name_col (str) – [“name-1”, “name-2”,…, “name-N”]

• cap (str) – the capacity, number in str

• pool (str) – the pool for the volume

• stgtype (str) – select from types.DS8K_VOLUME_TYPES, default to 'fb'

• captype (str) – select from types.DS8K_CAPTYPES, default to 'gib'

• lss (str) – logical subsystem id

• tp (str) – storage allocation method, in none, ese, tse

• ids (list) – list of volume ids to be created

Returns

A list of pyds8k.resources.ds8k.v1.volumes.Volume.

Return type

list

delete_volume(volume_id)

Delete A volume.

Parameters

volume_id (str) – Required. id of the target volume.

Returns

tuple of DS8000 Server Response.

Return type

tuple

get_volume(volume_id)

Get A volume.

Parameters

volume_id (str) – Required. id of the target volume.

Returns

pyds8k.resources.ds8k.v1.volumes.Volume.

Return type

object

get_volumes(volume_id=None)

Get Volumes

Parameters

volume_id (str) – id of the target volume. Get all if none.

Returns

A list of pyds8k.resources.ds8k.v1.volumes.Volume.

Return type

list

update_volume_extend(volume_id, new_size, captype='')

Parameters

• volume_id (str) – Required. id of the target volume.

• new_size (str) – Required. new size of the target volume.

• captype (str) – Required. select from types.DS8K_CAPTYPES.

Returns

pyds8k.resources.ds8k.v1.volumes.Volume.

Return type

object

update_volume_move(volume_id, new_pool)

Move one volume to a new extent pool. :param volume_id: Required. id of the target volume. :type volume_id: str :param new_pool: Required. id of the new extent pool. :type new_pool: str

Returns

pyds8k.resources.ds8k.v1.volumes.Volume.

Return type

object

update_volume_rename(volume_id, new_name)

Rename a volume by its id

Parameters

• volume_id (str) – id of the volume

• new_name (str) – the new name of the volume

Returns

pyds8k.resources.ds8k.v1.volumes.Volume.

Return type

object

class pyds8k.resources.ds8k.v1.common.mixins.VolmapMixin

Bases: object

create_mappings(volumes=None, mappings=None)

Create the Mapping of the Volume by Volume id for the Caller Object.

Parameters

• volumes (list) – Required. volume ids. Default is [].

• mappings (list) – Required. mappings. Default is [].

Returns

A list of pyds8k.resources.ds8k.v1.mappings.Volmap.

Return type

list

delete_mapping(lunid)

Delete the Mapping of the Volume by Volume id for the Caller Object.

Parameters

lunid (str) – Required. id of the volume.

Returns

tuple of DS8000 RESTAPI Server Response.

Return type

tuple

get_mapping(lunid)

Get the Mapping of the Volume by Volume id for the Caller Object.

Parameters

lunid (str) – Required. id of the volume.

Returns

pyds8k.resources.ds8k.v1.mappings.Volmap.

Return type

object

get_mappings(lunid=None)

Get Mappings of the Volume by Volume id for the Caller Object.

Parameters

lunid (str) – id of the volume. Get all if None.

Returns

A list of pyds8k.resources.ds8k.v1.mappings.Volmap.

Return type

list

class pyds8k.resources.ds8k.v1.common.mixins.VolumeMixin

Bases: object

get_volume(volume_id)

Get A Volume for the Caller Object.

Parameters

volume_id (str) – Required. id of the volume.

Returns

list: A list of pyds8k.resources.ds8k.v1.volumes.Volume.

Return type

object

get_volumes(volume_id=None)

Get Volumes for the Caller Object.

Parameters

volume_id (str) – id of the volume. Get all if None.

Returns

A list of pyds8k.resources.ds8k.v1.volumes.Volume.

Return type

list

Module contents