../E26585-05.epub /> ../E26585-05.mobi />

createSettingsDocument

Use the createSettingsDocument command to create a settings document for input to the createOrUpdatePolicy command.

A settings document is an XML file. The source of the settings document can be a policy template or an existing policy.

  • If you specify a policy template, the command returns the default settings document for the policy template.

  • If you specify a policy, the command returns a settings document with the settings for the current policy instance. You can edit the values in the settings document before submitting it to the createOrUpdatePolicy command.

To determine the type and subtype of a policy or policy template, select the appropriate object in the Navigator. The type and subtype for each policy or policy template is displayed in the summary pane.

Command Syntax

btmcli createSettingsDocument -n name [-t type] [-subType subType[ [-V version]
                              -fromPolicy [-o outputFile]
                              -s sphereUrl -l username:password
Name Long Name Description
-n -name The name of the template or policy whose settings document you want to use.
-t -type The type of the policy template or policy whose settings document you want to use.
-subType -- The subtype of the policy template or policy whose settings document you want to use.
-V -version The version of the policy template or policy whose settings document you want to use.
-fromPolicy -- Indicates that the settings document should be constructed using a pre-existing policy instance and not a template.
-o -outputFile The file where the settings document is written. If this is not specified, the settings document is sent to standard output.
-s -sphereUrl The URL of the sphere.

http://hostname:port/btmcentral/sphere/

This flag is not required if you have set the AP_SPHERE_URL environment variable for your sphere.

-l -userLogin The username and password associated with the sphere, in the format: username:password. This set of credentials must belong to a user in the btmadmin role.

See Security Options in Accessing CLI Commands for information on furnishing login credentials.

You can encrypt passwords using the encryptPassword command.


Example

The following example shows the createSettingsDocument command used to create the settings document MySettingsDoc.

btmcli createSettingsDocument -namemySecurePolicy -o mySettingsDoc
                  -s http://localhost:8080/btmcentral/sphere/
                  -l admin:abracadabra