Riva CLI commands --policy
--policy has several subcommands to perform various operations on a policy.
Using the --policy command without a subcommand has the same effect as using it with its --help subcommand.
Subcommands:
--help --syncNow --disable --enable --addAdvancedKey --deleteAdvancedKey
--help
Produces a policy-specific help output that includes descriptions of --policy subcommands and examples.
Syntax:
RivaCli.exe --policy –-help
--syncNow
Executes the SyncNow operation in a specific policy for a specific user.
Syntax:
RivaCli.exe --policy --syncNow
--policyId="policy-file-name"
--entityName="riva-user@your-domain.com"
[--path="path-string"]
Parameters:
--policyId (string)
Required. The ID number of the policy to perform the Sync Now operation with.
--entity name (string)
Required. The email address of the user or entity that needs to be synced now.
--path (string)
Optional. The complete path of the policy file, including the policy file name.
If --path is not specified, Riva CLI finds the folder that contains Riva.exe and looks for the policy in the Configuration subfolder.
Example:
RivaCli.exe --policy --syncNow --policyId="policy-file-name" --entityName="riva-user@your-domain.com"
Result: Riva CLI looks up the policy named "policy-file-name" in the Configuration subfolder of the folder where Riva.exe is installed. If the policy is enabled, it is used to sync riva-user@your-domain.com as soon as the sync process allows.
--disable
Disables a specific policy.
Syntax:
RivaCli.exe --policy --disable
--policyId="policy-file-name"
[--path="path-string"]
Parameters:
--policyId (string)
Required. The ID number of the policy to disable.
--path (string)
Optional. The complete path of the policy file, including the policy file name.
If --path is not specified, Riva CLI finds the folder that contains Riva.exe and looks for the policy in the Configuration subfolder.
Example:
RivaCli.exe --policy --disable --policyId="policy-file-name"
Result: Riva CLI disables the policy named "policy-file-name" in the Configuration subfolder of the folder where Riva.exe is installed.
--enable
Enables a specific policy.
Syntax:
RivaCli.exe --policy --enable
--policyId="policy-file-name"
[--path="path-string"]
Parameters:
--policyId (string)
Required. The ID number of the policy to enable.
--path (string)
Optional. The complete path of the policy file, including the policy file name.
If --path is not specified, Riva CLI finds the folder that contains Riva.exe and looks for the policy in the Configuration subfolder.
Example:
RivaCli.exe --policy --enable --policyId="policy-file-name"
Result: Riva CLI enables the policy named "policy-file-name" in the Configuration subfolder of the folder where Riva.exe is installed.
--addAdvancedKey
Adds an advanced or custom option to a specific policy.
Syntax:
RivaCli.exe --policy --addAdvancedKey
--policyId="policy-file-name"
--Key="keyName"
--value="keyValue"
[--path="path-string"]
Parameters:
--policyId (string)
Required. The ID number of the policy to add an advanced or custom option to.
--key (string)
Required. The name of the advanced or custom option.
--value (string)
Required. The value assigned to the advanced or custom option determines the option's behaviour. The value is not case-sensitive.
--path (string)
Optional. The complete path of the policy file, including the policy file name.
If -- the path is not specified, Riva CLI finds the folder that contains Riva.exe and looks for the policy in the Configuration subfolder.
Example:
RivaCli.exe --policy --addAdvancedKey --policyId="policy-file-name" --Key="example" --value="true"
Result: Riva CLI finds the policy named "policy-file-name" in the Configuration subfolder of the folder where Riva.exe is installed. The advanced option "example" is then added to the policy and is set to "true".
--deleteAdvancedKey
Deletes an advanced or custom option from a specific policy.
Syntax:
RivaCli.exe --policy --addAdvancedKey
--policyId="policy-file-name"
--Key="keyName"
[--path="path-string"]
Parameters:
--policyId (string)
Required. The ID number of the policy to delete an advanced or custom option from.
--key (string)
Required. The name of the advanced or custom option.
--path (string)
Optional. The complete path of the policy file, including the policy file name.
If --the path is not specified, Riva CLI finds the folder that contains Riva.exe and looks for the policy in the Configuration subfolder.
Example:
RivaCli.exe --policy --deleteAdvancedKey --policyId="policy-file-name" --Key="example"
Result: Result: Riva CLI finds the policy named "policy-file-name" in the Configuration subfolder of the folder where Riva.exe is installed. The advanced option "example" is then deleted.