sharedfilesystem

class pulumi_openstack.sharedfilesystem.GetShareNetworkResult(cidr=None, description=None, ip_version=None, name=None, network_type=None, neutron_net_id=None, neutron_subnet_id=None, project_id=None, region=None, security_service_ids=None, segmentation_id=None, id=None)

A collection of values returned by getShareNetwork.

cidr = None

See Argument Reference above.

description = None

See Argument Reference above.

ip_version = None

See Argument Reference above.

name = None

See Argument Reference above.

network_type = None

See Argument Reference above.

neutron_net_id = None

See Argument Reference above.

neutron_subnet_id = None

See Argument Reference above.

project_id = None

The owner of the Share Network.

region = None

See Argument Reference above.

security_service_ids = None

The list of security service IDs associated with the share network.

segmentation_id = None

See Argument Reference above.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_openstack.sharedfilesystem.GetShareResult(availability_zone=None, description=None, export_locations=None, is_public=None, metadata=None, name=None, project_id=None, region=None, share_network_id=None, share_proto=None, size=None, snapshot_id=None, status=None, id=None)

A collection of values returned by getShare.

availability_zone = None

The share availability zone.

description = None

See Argument Reference above.

export_locations = None

A list of export locations. For example, when a share server has more than one network interface, it can have multiple export locations.

is_public = None

See Argument Reference above.

metadata = None

See Argument Reference above.

name = None

See Argument Reference above.

project_id = None

See Argument Reference above.

region = None

The region in which to obtain the V2 Shared File System client.

share_network_id = None

See Argument Reference above.

share_proto = None

The share protocol.

size = None

The share size, in GBs.

snapshot_id = None

See Argument Reference above.

status = None

See Argument Reference above.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_openstack.sharedfilesystem.GetSnapshotResult(description=None, name=None, project_id=None, region=None, share_id=None, share_proto=None, share_size=None, size=None, status=None, id=None)

A collection of values returned by getSnapshot.

description = None

See Argument Reference above.

name = None

See Argument Reference above.

project_id = None

See Argument Reference above.

share_id = None

The UUID of the source share that was used to create the snapshot.

share_proto = None

The file system protocol of a share snapshot.

share_size = None

The share snapshot size, in GBs.

size = None

The snapshot size, in GBs.

status = None

See Argument Reference above.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_openstack.sharedfilesystem.SecurityService(resource_name, opts=None, description=None, dns_ip=None, domain=None, name=None, ou=None, password=None, region=None, server=None, type=None, user=None, __name__=None, __opts__=None)

Use this resource to configure a security service.

A security service stores configuration information for clients for authentication and authorization (AuthN/AuthZ). For example, a share server will be the client for an existing service such as LDAP, Kerberos, or Microsoft Active Directory.

Minimum supported Manila microversion is 2.7.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • description (pulumi.Input[str]) – The human-readable description for the security service. Changing this updates the description of the existing security service.
  • dns_ip (pulumi.Input[str]) – The security service DNS IP address that is used inside the tenant network.
  • domain (pulumi.Input[str]) – The security service domain.
  • name (pulumi.Input[str]) – The name of the security service. Changing this updates the name of the existing security service.
  • ou (pulumi.Input[str]) – The security service ou. An organizational unit can be added to specify where the share ends up. New in Manila microversion 2.44.
  • password (pulumi.Input[str]) – The user password, if you specify a user.
  • region (pulumi.Input[str]) – The region in which to obtain the V2 Shared File System client. A Shared File System client is needed to create a security service. If omitted, the region argument of the provider is used. Changing this creates a new security service.
  • server (pulumi.Input[str]) – The security service host name or IP address.
  • type (pulumi.Input[str]) – The security service type - can either be active_directory, kerberos or ldap. Changing this updates the existing security service.
  • user (pulumi.Input[str]) – The security service user or group name that is used by the tenant.
description = None

The human-readable description for the security service. Changing this updates the description of the existing security service.

dns_ip = None

The security service DNS IP address that is used inside the tenant network.

domain = None

The security service domain.

name = None

The name of the security service. Changing this updates the name of the existing security service.

ou = None

The security service ou. An organizational unit can be added to specify where the share ends up. New in Manila microversion 2.44.

password = None

The user password, if you specify a user.

project_id = None

The owner of the Security Service.

region = None

The region in which to obtain the V2 Shared File System client. A Shared File System client is needed to create a security service. If omitted, the region argument of the provider is used. Changing this creates a new security service.

server = None

The security service host name or IP address.

type = None

The security service type - can either be active_directory, kerberos or ldap. Changing this updates the existing security service.

user = None

The security service user or group name that is used by the tenant.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_openstack.sharedfilesystem.Share(resource_name, opts=None, availability_zone=None, description=None, is_public=None, metadata=None, name=None, region=None, share_network_id=None, share_proto=None, share_type=None, size=None, snapshot_id=None, __name__=None, __opts__=None)

Use this resource to configure a share.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • availability_zone (pulumi.Input[str]) – The share availability zone. Changing this creates a new share.
  • description (pulumi.Input[str]) – The human-readable description for the share. Changing this updates the description of the existing share.
  • is_public (pulumi.Input[bool]) – The level of visibility for the share. Set to true to make share public. Set to false to make it private. Default value is false. Changing this updates the existing share.
  • metadata (pulumi.Input[dict]) – One or more metadata key and value pairs as a dictionary of strings.
  • name (pulumi.Input[str]) – The name of the share. Changing this updates the name of the existing share.
  • region (pulumi.Input[str]) – The region in which to obtain the V2 Shared File System client. A Shared File System client is needed to create a share. Changing this creates a new share.
  • share_network_id (pulumi.Input[str]) – The UUID of a share network where the share server exists or will be created. If share_network_id is not set and you provide a snapshot_id, the share_network_id value from the snapshot is used. Changing this creates a new share.
  • share_proto (pulumi.Input[str]) – The share protocol - can either be NFS, CIFS, CEPHFS, GLUSTERFS, HDFS or MAPRFS. Changing this creates a new share.
  • share_type (pulumi.Input[str]) – The share type name. If you omit this parameter, the default share type is used.
  • size (pulumi.Input[int]) – The share size, in GBs. The requested share size cannot be greater than the allowed GB quota. Changing this resizes the existing share.
  • snapshot_id (pulumi.Input[str]) – The UUID of the share’s base snapshot. Changing this creates a new share.
availability_zone = None

The share availability zone. Changing this creates a new share.

description = None

The human-readable description for the share. Changing this updates the description of the existing share.

export_locations = None

A list of export locations. For example, when a share server has more than one network interface, it can have multiple export locations.

has_replicas = None

Indicates whether a share has replicas or not.

host = None

The share host name.

is_public = None

The level of visibility for the share. Set to true to make share public. Set to false to make it private. Default value is false. Changing this updates the existing share.

metadata = None

One or more metadata key and value pairs as a dictionary of strings.

name = None

The name of the share. Changing this updates the name of the existing share.

project_id = None

The owner of the Share.

region = None

The region in which to obtain the V2 Shared File System client. A Shared File System client is needed to create a share. Changing this creates a new share.

replication_type = None

The share replication type.

share_network_id = None

The UUID of a share network where the share server exists or will be created. If share_network_id is not set and you provide a snapshot_id, the share_network_id value from the snapshot is used. Changing this creates a new share.

share_proto = None

The share protocol - can either be NFS, CIFS, CEPHFS, GLUSTERFS, HDFS or MAPRFS. Changing this creates a new share.

share_server_id = None

The UUID of the share server.

share_type = None

The share type name. If you omit this parameter, the default share type is used.

size = None

The share size, in GBs. The requested share size cannot be greater than the allowed GB quota. Changing this resizes the existing share.

snapshot_id = None

The UUID of the share’s base snapshot. Changing this creates a new share.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_openstack.sharedfilesystem.ShareAccess(resource_name, opts=None, access_level=None, access_to=None, access_type=None, region=None, share_id=None, __name__=None, __opts__=None)

Use this resource to control the share access lists.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • access_level (pulumi.Input[str]) – The access level to the share. Can either be rw or ro.
  • access_to (pulumi.Input[str]) – The value that defines the access. Can either be an IP address or a username verified by configured Security Service of the Share Network.
  • access_type (pulumi.Input[str]) – The access rule type. Can either be an ip, user or cert.
  • region (pulumi.Input[str]) – The region in which to obtain the V2 Shared File System client. A Shared File System client is needed to create a share access. Changing this creates a new share access.
  • share_id (pulumi.Input[str]) – The UUID of the share to which you are granted access.
access_level = None

The access level to the share. Can either be rw or ro.

access_to = None

The value that defines the access. Can either be an IP address or a username verified by configured Security Service of the Share Network.

access_type = None

The access rule type. Can either be an ip, user or cert.

region = None

The region in which to obtain the V2 Shared File System client. A Shared File System client is needed to create a share access. Changing this creates a new share access.

share_id = None

The UUID of the share to which you are granted access.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_openstack.sharedfilesystem.ShareNetwork(resource_name, opts=None, description=None, name=None, neutron_net_id=None, neutron_subnet_id=None, region=None, security_service_ids=None, __name__=None, __opts__=None)

Use this resource to configure a share network.

A share network stores network information that share servers can use when shares are created.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • description (pulumi.Input[str]) – The human-readable description for the share network. Changing this updates the description of the existing share network.
  • name (pulumi.Input[str]) – The name for the share network. Changing this updates the name of the existing share network.
  • neutron_net_id (pulumi.Input[str]) – The UUID of a neutron network when setting up or updating a share network. Changing this updates the existing share network if it’s not used by shares.
  • neutron_subnet_id (pulumi.Input[str]) – The UUID of the neutron subnet when setting up or updating a share network. Changing this updates the existing share network if it’s not used by shares.
  • region (pulumi.Input[str]) – The region in which to obtain the V2 Shared File System client. A Shared File System client is needed to create a share network. If omitted, the region argument of the provider is used. Changing this creates a new share network.
  • security_service_ids (pulumi.Input[list]) – The list of security service IDs to associate with the share network. The security service must be specified by ID and not name.
cidr = None

The share network CIDR.

description = None

The human-readable description for the share network. Changing this updates the description of the existing share network.

ip_version = None

The IP version of the share network. Can either be 4 or 6.

name = None

The name for the share network. Changing this updates the name of the existing share network.

network_type = None

The share network type. Can either be VLAN, VXLAN, GRE, or flat.

neutron_net_id = None

The UUID of a neutron network when setting up or updating a share network. Changing this updates the existing share network if it’s not used by shares.

neutron_subnet_id = None

The UUID of the neutron subnet when setting up or updating a share network. Changing this updates the existing share network if it’s not used by shares.

project_id = None

The owner of the Share Network.

region = None

The region in which to obtain the V2 Shared File System client. A Shared File System client is needed to create a share network. If omitted, the region argument of the provider is used. Changing this creates a new share network.

security_service_ids = None

The list of security service IDs to associate with the share network. The security service must be specified by ID and not name.

segmentation_id = None

The share network segmentation ID.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
pulumi_openstack.sharedfilesystem.get_share(description=None, export_location_path=None, is_public=None, metadata=None, name=None, region=None, share_network_id=None, snapshot_id=None, status=None)

Use this data source to get the ID of an available Shared File System share.

pulumi_openstack.sharedfilesystem.get_share_network(description=None, ip_version=None, name=None, network_type=None, neutron_net_id=None, neutron_subnet_id=None, region=None, security_service_id=None, segmentation_id=None)

Use this data source to get the ID of an available Shared File System share network.

pulumi_openstack.sharedfilesystem.get_snapshot(description=None, name=None, region=None, share_id=None, status=None)

Use this data source to get the ID of an available Shared File System snapshot.