Class: Ansible::Ruby::Modules::Ovirt_storage_domain

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_storage_domain.rb,
lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_storage_domains.rb

Overview

Module to manage storage domains in oVirt/RHV

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#backup ⇒ Symbol?

Returns Boolean flag which indicates whether the storage domain is configured as backup or not.

Returns:

  • (Symbol, nil) —

    Boolean flag which indicates whether the storage domain is configured as backup or not.



68
 
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_storage_domain.rb', line 68

attribute :backup

#comment ⇒ Object?

Returns Comment of the storage domain.

Returns:

  • (Object, nil) —

    Comment of the storage domain.



26
 
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_storage_domain.rb', line 26

attribute :comment

#critical_space_action_blocker ⇒ Integer?

Returns Indicates the minimal free space the storage domain should contain in percentages.

Returns:

  • (Integer, nil) —

    Indicates the minimal free space the storage domain should contain in percentages.



72
 
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_storage_domain.rb', line 72

attribute :critical_space_action_blocker

#data_center ⇒ String, ...

Returns Data center name where storage domain should be attached.,This parameter isn’t idempotent, it’s not possible to change data center of storage domain.

Returns:

  • (String, Integer, nil) —

    Data center name where storage domain should be attached.,This parameter isn’t idempotent, it’s not possible to change data center of storage domain.



29
 
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_storage_domain.rb', line 29

attribute :data_center

#description ⇒ Object?

Returns Description of the storage domain.

Returns:

  • (Object, nil) —

    Description of the storage domain.



23
 
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_storage_domain.rb', line 23

attribute :description

#destroy ⇒ Symbol?

Returns Logical remove of the storage domain. If I(true) retains the storage domain’s data for import.,This parameter is relevant only when C(state) is I(absent).

Returns:

  • (Symbol, nil) —

    Logical remove of the storage domain. If I(true) retains the storage domain’s data for import.,This parameter is relevant only when C(state) is I(absent).



80
 
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_storage_domain.rb', line 80

attribute :destroy

#discard_after_delete ⇒ Symbol?

Returns If I(True) storage domain blocks will be discarded upon deletion. Enabled by default.,This parameter is relevant only for block based storage domains.

Returns:

  • (Symbol, nil) —

    If I(True) storage domain blocks will be discarded upon deletion. Enabled by default.,This parameter is relevant only for block based storage domains.



88
 
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_storage_domain.rb', line 88

attribute :discard_after_delete

#domain_function ⇒ :data, ...

Returns Function of the storage domain.,This parameter isn’t idempotent, it’s not possible to change domain function of storage domain.

Returns:

  • (:data, :iso, :export, nil) —

    Function of the storage domain.,This parameter isn’t idempotent, it’s not possible to change domain function of storage domain.



33
 
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_storage_domain.rb', line 33

attribute :domain_function

#fcp ⇒ Hash?

Returns Dictionary with values for fibre channel storage type:,C(lun_id) - LUN id.,C(override_luns) - If I(True) FCP storage domain LUNs will be overridden before adding.,Note that these parameters are not idempotent.

Returns:

  • (Hash, nil) —

    Dictionary with values for fibre channel storage type:,C(lun_id) - LUN id.,C(override_luns) - If I(True) FCP storage domain LUNs will be overridden before adding.,Note that these parameters are not idempotent.



60
 
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_storage_domain.rb', line 60

attribute :fcp

#format ⇒ Symbol?

Returns If I(True) storage domain will be formatted after removing it from oVirt/RHV.,This parameter is relevant only when C(state) is I(absent).

Returns:

  • (Symbol, nil) —

    If I(True) storage domain will be formatted after removing it from oVirt/RHV.,This parameter is relevant only when C(state) is I(absent).



84
 
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_storage_domain.rb', line 84

attribute :format

#glusterfs ⇒ Hash?

Returns Dictionary with values for GlusterFS storage type:,C(address) - Address of the Gluster server. E.g.: myserver.mydomain.com,C(path) - Path of the mount point. E.g.: /path/to/my/data,C(mount_options) - Option which will be passed when mounting storage.,Note that these parameters are not idempotent.

Returns:

  • (Hash, nil) —

    Dictionary with values for GlusterFS storage type:,C(address) - Address of the Gluster server. E.g.: myserver.mydomain.com,C(path) - Path of the mount point. E.g.: /path/to/my/data,C(mount_options) - Option which will be passed when mounting storage.,Note that these parameters are not idempotent.



56
 
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_storage_domain.rb', line 56

attribute :glusterfs

#host ⇒ String?

Returns Host to be used to mount storage.

Returns:

  • (String, nil) —

    Host to be used to mount storage.



37
 
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_storage_domain.rb', line 37

attribute :host

#id ⇒ Object?

Returns Id of the storage domain to be imported.

Returns:

  • (Object, nil) —

    Id of the storage domain to be imported.



12
 
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_storage_domain.rb', line 12

attribute :id

#iscsi ⇒ Hash?

Returns Dictionary with values for iSCSI storage type:,C(address) - Address of the iSCSI storage server.,C(port) - Port of the iSCSI storage server.,C(target) - The target IQN for the storage device.,C(lun_id) - LUN id(s).,C(username) - A CHAP user name for logging into a target.,C(password) - A CHAP password for logging into a target.,C(override_luns) - If I(True) ISCSI storage domain luns will be overridden before adding.,C(target_lun_map) - List of dictionary containing targets and LUNs.“,Note that these parameters are not idempotent.,Parameter C(target_lun_map) is supported since Ansible 2.5.

Returns:

  • (Hash, nil) —

    Dictionary with values for iSCSI storage type:,C(address) - Address of the iSCSI storage server.,C(port) - Port of the iSCSI storage server.,C(target) - The target IQN for the storage device.,C(lun_id) - LUN id(s).,C(username) - A CHAP user name for logging into a target.,C(password) - A CHAP password for logging into a target.,C(override_luns) - If I(True) ISCSI storage domain luns will be overridden before adding.,C(target_lun_map) - List of dictionary containing targets and LUNs.“,Note that these parameters are not idempotent.,Parameter C(target_lun_map) is supported since Ansible 2.5.



49
 
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_storage_domain.rb', line 49

attribute :iscsi

#localfs ⇒ Hash?

Returns Dictionary with values for localfs storage type:,C(path) - Path of the mount point. E.g.: /path/to/my/data,Note that these parameters are not idempotent.

Returns:

  • (Hash, nil) —

    Dictionary with values for localfs storage type:,C(path) - Path of the mount point. E.g.: /path/to/my/data,Note that these parameters are not idempotent.



41
 
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_storage_domain.rb', line 41

attribute :localfs

#name ⇒ String?

Returns Name of the storage domain to manage. (Not required when state is I(imported)).

Returns:

  • (String, nil) —

    Name of the storage domain to manage. (Not required when state is I(imported))



15
 
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_storage_domain.rb', line 15

attribute :name

#nfs ⇒ Hash?

Returns Dictionary with values for NFS storage type:,C(address) - Address of the NFS server. E.g.: myserver.mydomain.com,C(path) - Path of the mount point. E.g.: /path/to/my/data,C(version) - NFS version. One of: I(auto), I(v3), I(v4) or I(v4_1).,C(timeout) - The time in tenths of a second to wait for a response before retrying NFS requests. Range 0 to 65535.,C(retrans) - The number of times to retry a request before attempting further recovery actions. Range 0 to 65535.,C(mount_options) - Option which will be passed when mounting storage.,Note that these parameters are not idempotent.

Returns:

  • (Hash, nil) —

    Dictionary with values for NFS storage type:,C(address) - Address of the NFS server. E.g.: myserver.mydomain.com,C(path) - Path of the mount point. E.g.: /path/to/my/data,C(version) - NFS version. One of: I(auto), I(v3), I(v4) or I(v4_1).,C(timeout) - The time in tenths of a second to wait for a response before retrying NFS requests. Range 0 to 65535.,C(retrans) - The number of times to retry a request before attempting further recovery actions. Range 0 to 65535.,C(mount_options) - Option which will be passed when mounting storage.,Note that these parameters are not idempotent.



45
 
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_storage_domain.rb', line 45

attribute :nfs

#posixfs ⇒ Object?

Returns Dictionary with values for PosixFS storage type:,C(path) - Path of the mount point. E.g.: /path/to/my/data,C(vfs_type) - Virtual File System type.,C(mount_options) - Option which will be passed when mounting storage.,Note that these parameters are not idempotent.

Returns:

  • (Object, nil) —

    Dictionary with values for PosixFS storage type:,C(path) - Path of the mount point. E.g.: /path/to/my/data,C(vfs_type) - Virtual File System type.,C(mount_options) - Option which will be passed when mounting storage.,Note that these parameters are not idempotent.



53
 
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_storage_domain.rb', line 53

attribute :posixfs

#state ⇒ :present, ...

Returns Should the storage domain be present/absent/maintenance/unattached/imported/update_ovf_store,I(imported) is supported since version 2.4.,I(update_ovf_store) is supported since version 2.5, currently if C(wait) is (true), we don’t wait for update.

Returns:

  • (:present, :absent, :maintenance, :unattached, :imported, :update_ovf_store, nil) —

    Should the storage domain be present/absent/maintenance/unattached/imported/update_ovf_store,I(imported) is supported since version 2.4.,I(update_ovf_store) is supported since version 2.5, currently if C(wait) is (true), we don’t wait for update.



19
 
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_storage_domain.rb', line 19

attribute :state

#warning_low_space ⇒ Integer?

Returns Indicates the minimum percentage of a free space in a storage domain to present a warning.

Returns:

  • (Integer, nil) —

    Indicates the minimum percentage of a free space in a storage domain to present a warning.



76
 
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_storage_domain.rb', line 76

attribute :warning_low_space

#wipe_after_delete ⇒ Symbol?

Returns Boolean flag which indicates whether the storage domain should wipe the data after delete.

Returns:

  • (Symbol, nil) —

    Boolean flag which indicates whether the storage domain should wipe the data after delete.



64
 
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_storage_domain.rb', line 64

attribute :wipe_after_delete