Nortel Networks AS 5300 manual Optional syntax, Brackets, Angle brackets

Page 18

18Using the Bulk Provisioning Tool

Optional syntax

In BPT provisioning method syntax, the word [optional] indicates that what follows is optional and is not needed to invoke the method. Typically, the option is the writing of the returned values to a text file. You do not include [optional] when entering the syntax. For example, the following is the complete syntax for the getSysRoles method:

getSysRoles [optional] into <file name>

To write the returned information to the screen, you use the syntax: getSysRoles. To write the returned information to a file named roles.txt, you use the syntax: getSysRoles into roles.txt. The system creates the file with the name entered in the BPT command line.

When a get* command is not limited to a specific instance (for example, getSysRoles or getAllRights), you cannot use the shortcut number (BPT main menu option) when writing to a file. You must enter the BPT provisioning method syntax on the BPT command line. If you use the shortcut number, the returned information is written to the screen by default.

Brackets

Brackets () are required around the parameters when shown in the BPT provisioning method syntax. For example, the following is the syntax for the getRole provisioning method:

getRole using (Role name) file <file name> [optional] into <file name>

With this provisioning method, brackets are required around the provisioning Role name. For example, to retrieve the definition for the configured SuperUser role, you use the following syntax: getRole using (SuperUser).

Angle brackets

Angle brackets (<>) in the syntax indicate a variable. You replace the variable name and angle brackets with the specific variable when you invoke the provisioning method. For example, the following is the syntax for the getSysRoles provisioning method:

getSysRoles [optional] into <file name>

With this provisioning method, the angle brackets indicate that file name is a variable, replaced when using the provisioning method. For example, if you want to write the returned values to a file name called roles.txt, you use the syntax: getSysRoles into roles.txt.

Nortel AS 5300

Nortel Application Server 5300 Application Programming Interfaces Reference

NN42040-110 01.01 Standard

11 June 2008

Copyright © 2008 Nortel Networks

Image 18
Contents NN42040-110 Legal Notice Contents Starting the Bulk Provisioning Tool New in this release Other changesNew in this release Audience IntroductionNavigation Related documentsIntroduction Application Programming Interface fundamentals Open Provisioning Interface fundamentalsWhy use the Bulk Provisioning Tool Bulk Provisioning Tool fundamentalsBulk Provisioning Tool requirements Following table lists the requirements to run the BPTApplication Programming Interface fundamentals Using the Bulk Provisioning Tool Install and launch the BPTBPT main menu BPT main menu Quit Navigation BPT provisioning methodsBPT files and scripts FilesBPT conventions and examples ScriptsMethod and file syntax conventions Angle brackets Optional syntaxBrackets GetSysRoles optional into file nameSquare brackets BarComma separated strings Fully qualified user nameSuccess indication on remove methods Unknown error messages Create and manage provisioning roles using the BPTDefine the new provisioning role Add the new provisioning role AddRole using file D\prov\addexample.txtGetRole using AddExample View the new provisioning roleDelete the new provisioning role BPT Help option Help addRoleBPT limitations BPT mapping to the Provisioning ClientBatch processing Resource useProvisioning data visibility Using the Bulk Provisioning Tool Using the Open Provisioning Interface Security, authentication, and authorizationSecurity Authentication Http Basic Authentication Onboard AuthenticationWS-Security UsernameToken Special note for .NET authentication headers Authorization Domain-level authorization Provisioning-level authorizationGenerate stubs Third-party client developmentGet the Wsdl WsdlImplement interface accessing stubs Access stubs from the third-party applicationStarting the Bulk Provisioning Tool Starting the Bulk Provisioning ToolProcedure Steps Downloading the Bulk Provisioning Tool to a workstationLaunching the BPT on a workstation Launching the BPT on a workstation Starting the Bulk Provisioning Tool Creating Open Provisioning Interface clients Prerequisites for creating OPI clientsCreating OPI clients Task flow for creating OPI clients Configuring the class path Retrieving the error codesDownloading the Axis toolkit \axis-14\webapps\axis\WEB-INF\lib\opiclient Downloading the Wsdl fileCompiling the client stubs Loadname/wsdl/opi\opi\service Writing a client to perform some specific OPI operationsExample Writing a client Writing a client to perform some specific OPI operations Compiling the client class Accessing the OPI Java docs Procedure StepsAdminAuthentication subfolder in the OPI Java Docs folder Writing a client to perform some specific OPI operations Accessing the OPI Java docs Importing a CA Certificate into the BPT Tool prompts Trust this certificate? noKeytool -list -v -keystore opitruststore Importing a CA Certificate into the BPT Page Nortel AS
Related manuals
Manual 92 pages 3.24 Kb