Chapter 16. Shared File System Service command-line client

Subcommands

absolute-limits

Print a list of absolute limits for a user.

access-allow

Allow access to the share.

access-deny

Deny access to a share.

access-list

Show access list for share.

create

Creates a new share (NFS, CIFS, GlusterFS or HDFS).

credentials

Show user credentials returned from auth.

delete

Remove one or more shares.

endpoints

Discover endpoints that get returned from the authenticate services.

extra-specs-list

Print a list of current 'share types and extra specs' (Admin Only).

force-delete

Attempt force-delete of share, regardless of state.

list

List NAS shares with filters.

manage

Manage share not handled by Manila.

metadata

Set or delete metadata on a share.

metadata-show

Show metadata of given share.

metadata-update-all

Update all metadata of a share.

pool-list

List all backend storage pools known to the scheduler (Admin only).

quota-class-show

List the quotas for a quota class.

quota-class-update

Update the quotas for a quota class.

quota-defaults

List the default quotas for a tenant.

quota-delete

Delete quota for a tenant/user. The quota will revert back to default.

quota-show

List the quotas for a tenant/user.

quota-update

Update the quotas for a tenant/user.

rate-limits

Print a list of rate limits for a user.

reset-state

Explicitly update the state of a share.

security-service-create

Create security service used by tenant.

security-service-delete

Delete security service.

security-service-list

Get a list of security services.

security-service-show

Show security service.

security-service-update

Update security service.

service-list

List all services.

share-network-create

Create description for network used by the tenant.

share-network-delete

Delete share network.

share-network-list

Get a list of network info.

share-network-security-service-add

Associate security service with share network.

share-network-security-service-list

Get list of security services associated with a given share network.

share-network-security-service-remove

Dissociate security service from share network.

share-network-show

Get a description for network used by the tenant.

share-network-update

Update share network data.

share-server-delete

Delete share server.

share-server-details

Show share server details.

share-server-list

List all share servers.

share-server-show

Show share server info.

show

Show details about a NAS share.

snapshot-create

Add a new snapshot.

snapshot-delete

Remove a snapshot.

snapshot-force-delete

Attempt force-delete of snapshot, regardless of state.

snapshot-list

List all the snapshots.

snapshot-rename

Rename a snapshot.

snapshot-reset-state

Explicitly update the state of a snapshot.

snapshot-show

Show details about a snapshot.

type-access-add

Adds share type access for the given project.

type-access-list

Print access information about the given share type.

type-access-remove

Removes share type access for the given project.

type-create

Create a new share type.

type-delete

Delete a specific share type.

type-key

Set or unset extra_spec for a share type.

type-list

Print a list of available 'share types'.

unmanage

Unmanage share.

update

Rename a share.

bash-completion

Print arguments for bash_completion. Prints all of the commands and options to stdout so that the manila.bash_completion script doesn't have to hard code them.

help

Display help about this program or one of its subcommands.

list-extensions

List all the os-api extensions that are available.

--version

show program's version number and exit

-d, --debug

Print debugging output.

--os-cache

Use the auth token cache. Defaults to env[OS_CACHE].

--os-reset-cache

Delete cached password and auth token.

--os-username <auth-user-name>

Defaults to env[OS_USERNAME].

--os-password <auth-password>

Defaults to env[OS_PASSWORD].

--os-tenant-name <auth-tenant-name>

Defaults to env[OS_TENANT_NAME].

--os-tenant-id <auth-tenant-id>

Defaults to env[OS_TENANT_ID].

--os-auth-url <auth-url>

Defaults to env[OS_AUTH_URL].

--os-region-name <region-name>

Defaults to env[OS_REGION_NAME].

--service-type <service-type>

Defaults to compute for most actions.

--service-name <service-name>

Defaults to env[MANILA_SERVICE_NAME].

--share-service-name <share-service-name>

Defaults to env[MANILA_share_service_name].

--endpoint-type <endpoint-type>

Defaults to env[MANILA_ENDPOINT_TYPE] or publicURL.

--os-share-api-version <compute-api-ver>

Accepts 1 or 2, defaults to env[OS_SHARE_API_VERSION].

--os-cacert <ca-certificate>

Specify a CA bundle file to use in verifying a TLS (https) server certificate. Defaults to env[OS_CACERT].

--retries <retries>

Number of retries.

Positional arguments

<share>

Name or ID of the NAS share to modify.

<access_type>

Access rule type (only "ip", "user"(user or group), and "cert" are supported).

<access_to>

Value that defines access.

Optional arguments

--access-level <access_level>, --access_level <access_level>

Share access level ("rw" and "ro" access levels are supported). Defaults to None.

Positional arguments

<share>

Name or ID of the NAS share to modify.

<id>

ID of the access rule to be deleted.

Positional arguments

<share>

Name or ID of the share.

Positional arguments

<share_protocol>

Share type (NFS, CIFS, GlusterFS or HDFS).

<size>

Share size in GB.

Optional arguments

--snapshot-id <snapshot-id>

Optional snapshot ID to create the share from. (Default=None)

--name <name>

Optional share name. (Default=None)

--metadata [<key=value> [<key=value> ...]]

Metadata key=value pairs (Optional, Default=None).

--share-network <network-info>

Optional network info ID or name.

--description <description>

Optional share description. (Default=None)

--share-type <share-type>, --share_type <share-type>, --volume-type <share-type>, --volume_type <share-type>

Optional share type. Use of optional volume type is deprecated(Default=None)

--public

Level of visibility for share. Defines whether other tenants are able to see it or not.

Positional arguments

<share>

Name or ID of the share(s).

Positional arguments

<share>

Name or ID of the share(s) to force delete.

Optional arguments

--all-tenants [<0|1>]

Display information from all tenants (Admin only).

--name <name>

Filter results by name.

--status <status>

Filter results by status.

--share-server-id <share_server_id>, --share-server_id <share_server_id>, --share_server-id <share_server_id>, --share_server_id <share_server_id>

Filter results by share server ID.

--metadata [<key=value> [<key=value> ...]]

Filters results by a metadata key and value. OPTIONAL: Default=None

--extra-specs [<key=value> [<key=value> ...]], --extra_specs [<key=value> [<key=value> ...]]

Filters results by a extra specs key and value of share type that was used for share creation. OPTIONAL: Default=None

--share-type <share_type>, --volume-type--share_type <share_type>, --share-type-id <share_type>, --volume-type-id <share_type>, --share-type_id <share_type>, --share_type-id <share_type>, --share_type_id <share_type>, --volume_type <share_type>, --volume_type_id <share_type>

Filter results by a share type id or name that was used for share creation.

--limit <limit>

Maximum number of shares to return. OPTIONAL: Default=None.

--offset <offset>

Set offset to define start point of share listing. OPTIONAL: Default=None.

--sort-key <sort_key>, --sort_key <sort_key>

Key to be sorted, available keys are ('id', 'status', 'size', 'host', 'share_proto', 'export_location', 'availability_zone', 'user_id', 'project_id', 'created_at', 'updated_at', 'display_name', 'name', 'share_type_id', 'share_type', 'share_network_id', 'share_network', 'snapshot_id', 'snapshot'). OPTIONAL: Default=None.

--sort-dir <sort_dir>, --sort_dir <sort_dir>

Sort direction, available values are ('asc', 'desc'). OPTIONAL: Default=None.

--snapshot <snapshot>

Filer results by snapshot name or id, that was used for share.

--host <host>

Filter results by host.

--share-network <share_network>, --share_network <share_network>

Filter results by share-network name or id.

--project-id <project_id>, --project_id <project_id>

Filter results by project id. Useful with set key '--all-tenants'.

--public

Add public shares from all tenants to result.

Positional arguments

<service_host>

manage-share service host: some.host@driver[#pool]

<protocol>

Protocol of the share to manage, such as NFS or CIFS.

<export_path>

Share export path.

Optional arguments

--name <name>

Optional share name. (Default=None)

--description <description>

Optional share description. (Default=None)

--share_type <share_type>, --share-type <share_type>

Optional share type assigned to share. (Default=None)

--driver_options [<key=value> [<key=value> ...]], --driver-options [<key=value> [<key=value> ...]]

Driver option key=value pairs (Optional, Default=None).

Positional arguments

<share>

Name or ID of the share to update metadata on.

<action>

Actions: 'set' or 'unset'.

<key=value>

Metadata to set or unset (key is only necessary on unset).

Positional arguments

<share>

Name or ID of the share.

Positional arguments

<share>

Name or ID of the share to update metadata on.

<key=value>

Metadata entry or entries to update.

Optional arguments

--host <host>

Filter results by host name. Regular expressions are supported.

--backend <backend>

Filter results by backend name. Regular expressions are supported.

--pool <pool>

Filter results by pool name. Regular expressions are supported.

Positional arguments

<class>

Name of quota class to list the quotas for.

Positional arguments

<class-name>

Name of quota class to set the quotas for.

Optional arguments

--shares <shares>

New value for the "shares" quota.

--snapshots <snapshots>

New value for the "snapshots" quota.

--gigabytes <gigabytes>

New value for the "gigabytes" quota.

--snapshot-gigabytes <snapshot_gigabytes>, --snapshot_gigabytes <snapshot_gigabytes>

New value for the "snapshot_gigabytes" quota.

--share-networks <share-networks>

New value for the "share_networks" quota.

Optional arguments

--tenant <tenant-id> ID

of tenant to list the default quotas for.

Optional arguments

--tenant <tenant-id> ID

of tenant to delete quota for.

--user <user-id> ID

of user to delete quota for.

Optional arguments

--tenant <tenant-id> ID

of tenant to list the quotas for.

--user <user-id> ID

of user to list the quotas for.

Positional arguments

<tenant_id>

UUID of tenant to set the quotas for.

Optional arguments

--user <user-id> ID

of user to set the quotas for.

--shares <shares>

New value for the "shares" quota.

--snapshots <snapshots>

New value for the "snapshots" quota.

--gigabytes <gigabytes>

New value for the "gigabytes" quota.

--snapshot-gigabytes <snapshot_gigabytes>, --snapshot_gigabytes <snapshot_gigabytes>

New value for the "snapshot_gigabytes" quota.

--share-networks <share-networks>

New value for the "share_networks" quota.

--force

Whether force update the quota even if the already used and reserved exceeds the new quota.

Positional arguments

<share>

Name or ID of the share to modify.

Optional arguments

--state <state>

Indicate which state to assign the share. Options include available, error, creating, deleting, error_deleting. If no state is provided, available will be used.

Positional arguments

<type>

Security service type: 'ldap', 'kerberos' or 'active_directory'.

Optional arguments

--dns-ip <dns_ip> DNS IP

address used inside tenant's network.

--server <server>

Security service IP address or hostname.

--domain <domain>

Security service domain.

--user <user>

Security service user or group used by tenant.

--password <password>

Password used by user.

--name <name>

Security service name.

--description <description>

Security service description.

Positional arguments

<security-service>

Security service name or ID to delete.

Optional arguments

--all-tenants [<0|1>]

Display information from all tenants (Admin only).

--share-network <share_network>, --share_network <share_network>

Filter results by share network id or name.

--status <status>

Filter results by status.

--name <name>

Filter results by name.

--type <type>

Filter results by type.

--user <user>

Filter results by user or group used by tenant.

--dns-ip <dns_ip>, --dns_ip <dns_ip>

Filter results by DNS IP address used inside tenant's network.

--server <server>

Filter results by security service IP address or hostname.

--domain <domain>

Filter results by domain.

--detailed [<0|1>]

Show detailed information about filtered security services.

--offset <offset>

Start position of security services listing.

--limit <limit>

Number of security services to return per request.

Positional arguments

<security-service>

Security service name or ID to show.

Positional arguments

<security-service>

Security service name or ID to update.

Optional arguments

--dns-ip <dns-ip> DNS IP

address used inside tenant's network.

--server <server>

Security service IP address or hostname.

--domain <domain>

Security service domain.

--user <user>

Security service user or group used by tenant.

--password <password>

Password used by user.

--name <name>

Security service name.

--description <description>

Security service description.

Optional arguments

--host <hostname>

Name of host.

--binary <binary>

Service binary.

--status <status>

Filter results by status.

--state <state>

Filter results by state.

--zone <zone>

Availability zone.

Optional arguments

--nova-net-id <nova-net-id>, --nova-net_id <nova-net-id>, --nova_net_id <nova-net-id>, --nova_net-id <nova-net-id>

Nova net ID. Used to set up network for share servers.

--neutron-net-id <neutron-net-id>, --neutron-net_id <neutron-net-id>, --neutron_net_id <neutron-net-id>, --neutron_net-id <neutron-net-id>

Neutron network ID. Used to set up network for share servers.

--neutron-subnet-id <neutron-subnet-id>, --neutron-subnet_id <neutron-subnet-id>, --neutron_subnet_id <neutron-subnet-id>, --neutron_subnet-id <neutron-subnet-id>

Neutron subnet ID. Used to set up network for share servers. This subnet should belong to specified neutron network.

--name <name>

Share network name.

--description <description>

Share network description.

Positional arguments

<share-network>

Name or ID of share network to be deleted.

Optional arguments

--all-tenants [<0|1>]

Display information from all tenants (Admin only).

--project-id <project_id>, --project_id <project_id>

Filter results by project ID.

--name <name>

Filter results by name.

--created-since <created_since>, --created_since <created_since>

Return only share networks created since given date. The date is in the format 'yyyy-mm-dd'.

--created-before <created_before>, --created_before <created_before>

Return only share networks created until given date. The date is in the format 'yyyy-mm-dd'.

--security-service <security_service>, --security_service <security_service>

Filter results by attached security service.

--nova-net-id <nova_net_id>, --nova_net_id <nova_net_id>, --nova_net-id <nova_net_id>, --nova-net_id <nova_net_id>

Filter results by Nova net ID.

--neutron-net-id <neutron_net_id>, --neutron_net_id <neutron_net_id>, --neutron_net-id <neutron_net_id>, --neutron-net_id <neutron_net_id>

Filter results by neutron net ID.

--neutron-subnet-id <neutron_subnet_id>, --neutron_subnet_id <neutron_subnet_id>, --neutron-subnet_id <neutron_subnet_id>, --neutron_subnet-id <neutron_subnet_id>

Filter results by neutron subnet ID.

--network-type <network_type>, --network_type <network_type>

Filter results by network type.

--segmentation-id <segmentation_id>, --segmentation_id <segmentation_id>

Filter results by segmentation ID.

--cidr <cidr>

Filter results by CIDR.

--ip-version <ip_version>, --ip_version <ip_version>

Filter results by IP version.

--offset <offset>

Start position of share networks listing.

--limit <limit>

Number of share networks to return per request.

Positional arguments

<share-network>

Share network name or ID.

<security-service>

Security service name or ID to associate with.

Positional arguments

<share-network>

Share network name or ID.

Positional arguments

<share-network>

Share network name or ID.

<security-service>

Security service name or ID to dissociate.

Positional arguments

<share-network>

Name or ID of the share network to show.

Positional arguments

<share-network>

Name or ID of share network to update.

Optional arguments

--nova-net-id <nova-net-id>, --nova-net_id <nova-net-id>, --nova_net_id <nova-net-id>, --nova_net-id <nova-net-id>

Nova net ID. Used to set up network for share servers.

--neutron-net-id <neutron-net-id>, --neutron-net_id <neutron-net-id>, --neutron_net_id <neutron-net-id>, --neutron_net-id <neutron-net-id>

Neutron network ID. Used to set up network for share servers.

--neutron-subnet-id <neutron-subnet-id>, --neutron-subnet_id <neutron-subnet-id>, --neutron_subnet_id <neutron-subnet-id>, --neutron_subnet-id <neutron-subnet-id>

Neutron subnet ID. Used to set up network for share servers. This subnet should belong to specified neutron network.

--name <name>

Share network name.

--description <description>

Share network description.

Positional arguments

<id>

ID of share server.

Positional arguments

<id>

ID of share server.

Optional arguments

--host <hostname>

Filter results by name of host.

--status <status>

Filter results by status.

--share-network <share_network>

Filter results by share network.

--project-id <project_id>

Filter results by project ID.

Positional arguments

<id>

ID of share server.

Positional arguments

<share>

Name or ID of the NAS share.

Positional arguments

<share>

Name or ID of the share to snapshot.

Optional arguments

--force <True|False>

Optional flag to indicate whether to snapshot a share even if it's busy. (Default=False)

--name <name>

Optional snapshot name. (Default=None)

--description <description>

Optional snapshot description. (Default=None)

Positional arguments

<snapshot>

Name or ID of the snapshot to delete.

Positional arguments

<snapshot>

Name or ID of the snapshot to force delete.

Optional arguments

--all-tenants [<0|1>]

Display information from all tenants (Admin only).

--name <name>

Filter results by name.

--status <status>

Filter results by status.

--share-id <share_id>, --share_id <share_id>

Filter results by source share ID.

--usage [any|used|unused]

Either filter or not snapshots by its usage. OPTIONAL: Default=any.

--limit <limit>

Maximum number of share snapshots to return. OPTIONAL: Default=None.

--offset <offset>

Set offset to define start point of share snapshots listing. OPTIONAL: Default=None.

--sort-key <sort_key>, --sort_key <sort_key>

Key to be sorted, available keys are ('id', 'status', 'size', 'share_id', 'user_id', 'project_id', 'progress', 'name', 'display_name'). OPTIONAL: Default=None.

--sort-dir <sort_dir>, --sort_dir <sort_dir>

Sort direction, available values are ('asc', 'desc'). OPTIONAL: Default=None.

Positional arguments

<snapshot>

Name or ID of the snapshot to rename.

<name>

New name for the snapshot.

Optional arguments

--description <description>

Optional snapshot description. (Default=None)

Positional arguments

<snapshot>

Name or ID of the snapshot to modify.

Optional arguments

--state <state>

Indicate which state to assign the snapshot. Options include available, error, creating, deleting, error_deleting. If no state is provided, available will be used.

Positional arguments

<snapshot>

Name or ID of the snapshot.

Positional arguments

<share_type>

Share type name or ID to add access for the given project.

<project_id>

Project ID to add share type access for.

Positional arguments

<share_type>

Filter results by share type name or ID.

Positional arguments

<share_type>

Share type name or ID to remove access for the given project.

<project_id>

Project ID to remove share type access for.

Positional arguments

<name>

Name of the new share type.

<spec_driver_handles_share_servers>

Required extra specification. Valid values 'true'/'1' and 'false'/'0'

Optional arguments

--is_public <is_public>, --is-public <is_public>

Make type accessible to the public (default true).

Positional arguments

<id>

Name or ID of the share type to delete.

Positional arguments

<stype>

Name or ID of the share type.

<action>

Actions: 'set' or 'unset'.

<key=value>

Extra_specs to set or unset (key is only necessary on unset).

Optional arguments

--all

Display all share types (Admin only).

Positional arguments

<share>

Name or ID of the share(s).

Positional arguments

<share>

Name or ID of the share to rename.

Optional arguments

--name <name>

New name for the share.

--description <description>

Optional share description. (Default=None)

--is-public <is_public>, --is_public <is_public>

Public share is visible for all tenants.