az netappfiles volume export-policy

Manage Azure NetApp Files (ANF) Volume export policies.

Commands

Name	Description	Type	Status
az netappfiles volume export-policy add	Add a new rule to the export policy for a volume.	Core	GA
az netappfiles volume export-policy list	List the export policy rules for a volume.	Core	GA
az netappfiles volume export-policy remove	Remove a rule from the export policy for a volume by rule index. The current rules can be obtained by performing the subgroup list command.	Core	GA
az netappfiles volume export-policy show	Show the export policy rule for a volume.	Core	GA
az netappfiles volume export-policy update	Update the export policy rule for a volume.	Core	GA
az netappfiles volume export-policy wait	Place the CLI in a waiting state until a condition is met.	Core	GA

az netappfiles volume export-policy add

Edit

Add a new rule to the export policy for a volume.

az netappfiles volume export-policy add --account-name
                                        --name --volume-name
                                        --pool-name
                                        --resource-group
                                        [--allowed-clients]
                                        [--chown-mode {Restricted, Unrestricted}]
                                        [--cifs {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--has-root-access {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--kerberos5-read-only {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--kerberos5-read-write {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--kerberos5i-read-only {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--kerberos5i-read-write {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--kerberos5p-read-only {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--kerberos5p-read-write {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--nfsv3 {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--nfsv41 {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--rule-index]
                                        [--unix-read-only {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--unix-read-write {0, 1, f, false, n, no, t, true, y, yes}]

Examples

Add an export policy rule for the ANF volume

az netappfiles volume export-policy add -g mygroup --account-name myaccname --pool-name mypoolname --name myvolname --allowed-clients "1.2.3.0/24" --rule-index 2 --unix-read-only true --unix-read-write false --cifs false --nfsv3 true --nfsv41 false

Required Parameters

--account-name -a

The name of the NetApp account.

--name --volume-name -n -v

The name of the volume.

--pool-name -p

The name of the capacity pool.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--allowed-clients

Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names.

Property	Value
Parameter group:	Export Policies Arguments

--chown-mode

This parameter specifies who is authorized to change the ownership of a file. restricted - Only root user can change the ownership of the file. unrestricted - Non-root users can change ownership of files that they own.

Property	Value
Parameter group:	Export Policies Arguments
Default value:	Restricted
Accepted values:	Restricted, Unrestricted

--cifs

Allows CIFS protocol.

Property	Value
Parameter group:	Body.properties.exportPolicy.rules[] Arguments
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--has-root-access

Has root access to volume.

Property	Value
Parameter group:	Export Policies Arguments
Default value:	True
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--kerberos5-read-only

Kerberos5 Read only access. To be use with swagger version 2020-05-01 or later.

Property	Value
Parameter group:	Body.properties.exportPolicy.rules[] Arguments
Default value:	False
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--kerberos5-read-write

Kerberos5 Read and write access. To be use with swagger version 2020-05-01 or later.

Property	Value
Parameter group:	Body.properties.exportPolicy.rules[] Arguments
Default value:	False
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--kerberos5i-read-only

Kerberos5i Read only access. To be use with swagger version 2020-05-01 or later.

Property	Value
Parameter group:	Body.properties.exportPolicy.rules[] Arguments
Default value:	False
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--kerberos5i-read-write

Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later.

Property	Value
Parameter group:	Body.properties.exportPolicy.rules[] Arguments
Default value:	False
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--kerberos5p-read-only

Kerberos5p Read only access. To be use with swagger version 2020-05-01 or later.

Property	Value
Parameter group:	Body.properties.exportPolicy.rules[] Arguments
Default value:	False
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--kerberos5p-read-write

Kerberos5p Read and write access. To be use with swagger version 2020-05-01 or later.

Property	Value
Parameter group:	Body.properties.exportPolicy.rules[] Arguments
Default value:	False
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--nfsv3

Allows NFSv3 protocol. Enable only for NFSv3 type volumes.

Property	Value
Parameter group:	Body.properties.exportPolicy.rules[] Arguments
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--nfsv41

Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes.

Property	Value
Parameter group:	Body.properties.exportPolicy.rules[] Arguments
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--rule-index

Order index.

--unix-read-only

Read only access.

Property	Value
Parameter group:	Body.properties.exportPolicy.rules[] Arguments
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--unix-read-write

Read and write access.

Property	Value
Parameter group:	Body.properties.exportPolicy.rules[] Arguments
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az netappfiles volume export-policy list

Edit

List the export policy rules for a volume.

az netappfiles volume export-policy list --account-name
                                         --name --volume-name
                                         --pool-name
                                         --resource-group

Examples

List the export policy rules for an ANF volume

az netappfiles volume export-policy list -g mygroup --account-name myaccname --pool-name mypoolname --name myvolname

Required Parameters

--account-name -a

The name of the NetApp account.

--name --volume-name -n -v

The name of the volume.

--pool-name -p

The name of the capacity pool.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az netappfiles volume export-policy remove

Edit

Remove a rule from the export policy for a volume by rule index. The current rules can be obtained by performing the subgroup list command.

az netappfiles volume export-policy remove --account-name
                                           --name --volume-name
                                           --pool-name
                                           --resource-group
                                           --rule-index
                                           [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                           [--yes]

Examples

Remove an export policy rule from an ANF volume

az netappfiles volume export-policy remove -g mygroup --account-name myaccname --pool-name mypoolname --name myvolname --rule-index 4

Required Parameters

--account-name -a

The name of the NetApp account.

--name --volume-name -n -v

The name of the volume.

--pool-name -p

The name of the capacity pool.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--rule-index

Order index.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--yes -y

Do not prompt for confirmation.

Property	Value
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az netappfiles volume export-policy show

Edit

Show the export policy rule for a volume.

az netappfiles volume export-policy show --account-name
                                         --name --volume-name
                                         --pool-name
                                         --resource-group
                                         --rule-index

Examples

Get an export policy rule for an ANF volume

az netappfiles volume export-policy show -g mygroup --account-name myaccname --pool-name mypoolname --name myvolname --rule-index 4

Required Parameters

--account-name -a

The name of the NetApp account.

--name --volume-name -n -v

The name of the volume.

--pool-name -p

The name of the capacity pool.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--rule-index

Order index.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az netappfiles volume export-policy update

Edit

Update the export policy rule for a volume.

az netappfiles volume export-policy update --account-name
                                           --name --volume-name
                                           --pool-name
                                           --resource-group
                                           --rule-index
                                           [--add]
                                           [--allowed-clients]
                                           [--chown-mode {Restricted, Unrestricted}]
                                           [--cifs {0, 1, f, false, n, no, t, true, y, yes}]
                                           [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                           [--has-root-access {0, 1, f, false, n, no, t, true, y, yes}]
                                           [--kerberos5-read-only {0, 1, f, false, n, no, t, true, y, yes}]
                                           [--kerberos5-read-write {0, 1, f, false, n, no, t, true, y, yes}]
                                           [--kerberos5i-read-only {0, 1, f, false, n, no, t, true, y, yes}]
                                           [--kerberos5i-read-write {0, 1, f, false, n, no, t, true, y, yes}]
                                           [--kerberos5p-read-only {0, 1, f, false, n, no, t, true, y, yes}]
                                           [--kerberos5p-read-write {0, 1, f, false, n, no, t, true, y, yes}]
                                           [--nfsv3 {0, 1, f, false, n, no, t, true, y, yes}]
                                           [--nfsv41 {0, 1, f, false, n, no, t, true, y, yes}]
                                           [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                           [--remove]
                                           [--set]
                                           [--unix-read-only {0, 1, f, false, n, no, t, true, y, yes}]
                                           [--unix-read-write {0, 1, f, false, n, no, t, true, y, yes}]

Examples

Update the export policy rule for a volume

az netappfiles volume export-policy update -g mygroup --account-name myaccname --pool-name mypoolname --name myvolname --rule-index 1 --allowed-clients '1.1.3.0/24'

Required Parameters

--account-name -a

The name of the NetApp account.

--name --volume-name -n -v

The name of the volume.

--pool-name -p

The name of the capacity pool.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--rule-index

Order index.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

Property	Value
Parameter group:	Generic Update Arguments

--allowed-clients

Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names.

Property	Value
Parameter group:	Export Policies Arguments

--chown-mode

Property	Value
Parameter group:	Export Policies Arguments
Accepted values:	Restricted, Unrestricted

--cifs

Allows CIFS protocol.

Property	Value
Parameter group:	Body.properties.exportPolicy.rules[] Arguments
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Property	Value
Parameter group:	Generic Update Arguments
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--has-root-access

Has root access to volume.

Property	Value
Parameter group:	Export Policies Arguments
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--kerberos5-read-only

Kerberos5 Read only access. To be use with swagger version 2020-05-01 or later.

Property	Value
Parameter group:	Body.properties.exportPolicy.rules[] Arguments
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--kerberos5-read-write

Kerberos5 Read and write access. To be use with swagger version 2020-05-01 or later.

Property	Value
Parameter group:	Body.properties.exportPolicy.rules[] Arguments
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--kerberos5i-read-only

Kerberos5i Read only access. To be use with swagger version 2020-05-01 or later.

Property	Value
Parameter group:	Body.properties.exportPolicy.rules[] Arguments
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--kerberos5i-read-write

Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later.

Property	Value
Parameter group:	Body.properties.exportPolicy.rules[] Arguments
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--kerberos5p-read-only

Kerberos5p Read only access. To be use with swagger version 2020-05-01 or later.

Property	Value
Parameter group:	Body.properties.exportPolicy.rules[] Arguments
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--kerberos5p-read-write

Kerberos5p Read and write access. To be use with swagger version 2020-05-01 or later.

Property	Value
Parameter group:	Body.properties.exportPolicy.rules[] Arguments
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--nfsv3

Allows NFSv3 protocol. Enable only for NFSv3 type volumes.

Property	Value
Parameter group:	Body.properties.exportPolicy.rules[] Arguments
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--nfsv41

Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes.

Property	Value
Parameter group:	Body.properties.exportPolicy.rules[] Arguments
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Property	Value
Parameter group:	Generic Update Arguments

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

Property	Value
Parameter group:	Generic Update Arguments

--unix-read-only

Read only access.

Property	Value
Parameter group:	Body.properties.exportPolicy.rules[] Arguments
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--unix-read-write

Read and write access.

Property	Value
Parameter group:	Body.properties.exportPolicy.rules[] Arguments
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az netappfiles volume export-policy wait

Edit

Place the CLI in a waiting state until a condition is met.

az netappfiles volume export-policy wait [--account-name]
                                         [--created]
                                         [--custom]
                                         [--deleted]
                                         [--exists]
                                         [--ids]
                                         [--interval]
                                         [--name --volume-name]
                                         [--pool-name]
                                         [--resource-group]
                                         [--subscription]
                                         [--timeout]
                                         [--updated]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--account-name -a

The name of the NetApp account.

Property	Value
Parameter group:	Resource Id Arguments

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Property	Value
Parameter group:	Wait Condition Arguments

--deleted

Wait until deleted.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--exists

Wait until the resource exists.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--interval

Polling interval in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	30

--name --volume-name -n -v

The name of the volume.

Property	Value
Parameter group:	Resource Id Arguments

--pool-name -p

The name of the capacity pool.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

--timeout

Maximum wait in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

Feedback

Was this page helpful?

Share via

az netappfiles volume export-policy

Commands

az netappfiles volume export-policy add

Examples

Required Parameters

Optional Parameters

az netappfiles volume export-policy list

Examples

Required Parameters

az netappfiles volume export-policy remove

Examples

Required Parameters

Optional Parameters

az netappfiles volume export-policy show

Examples

Required Parameters

az netappfiles volume export-policy update

Examples

Required Parameters

Optional Parameters

az netappfiles volume export-policy wait

Optional Parameters

Feedback