Nortel Networks AS 5300 manual Square brackets, Bar

Page 19

BPT conventions and examples 19

Square brackets

Square brackets ([ ]) in the syntax indicate a string of variables, separated by commas. The square brackets must be included when shown in the BPT provisioning method syntax. For example, the following is the syntax for the addRole provisioning method:

addRole using ([Name of the Provisioning Role,Description of the Role,[[The Provisioning Right Type,The Read privilege,The write privilege,The delete privilege], .. ,[The Provisioning Right Type,The Read privilege,The write privilege,The delete privilege]]]) file <file name> [optional] into <file name>

With this provisioning method, the square brackets separate fields of the role description being added. For example, if you are adding a role called AddExample, the syntax looks like: addRole using

([AddExample,BPT add example,[[Domain Management, true,true,false],[Device Management,true,false, false],[Admin,true,true,true]]]).

Bar

A bar () in the syntax means that there are two ways of entering the required provisioning method information. Typically, the bar is used for the data entry option—entering the data in the command line or using data in a file. 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, you can enter the Role name in the BPT command line, or enter it using a file. For example, the following is the syntax for invoking the provisioning method on the BPT command line for the Superuser role: getRole using (SuperUser).

Optionally, you can invoke the provisioning method using the Role name listed in a file. For example, the following is the syntax to invoke the provisioning method using a file (containing the Superuser role) called SuperUser_role.txt: getRole using file SuperUser_role.txt.

The contents of the file must be in the correct format. Use the help command to display the BPT required file format. Note in the above example, that the role name in the file is not enclosed in brackets as it is if this method is invoked from the BPT command line.

Nortel AS 5300

Nortel Application Server 5300 Application Programming Interfaces Reference

NN42040-110 01.01 Standard

11 June 2008

Copyright © 2008 Nortel Networks

Image 19
Contents NN42040-110 Legal Notice Contents Starting the Bulk Provisioning Tool Other changes New in this releaseNew in this release Related documents IntroductionNavigation AudienceIntroduction Open Provisioning Interface fundamentals Application Programming Interface fundamentalsBulk Provisioning Tool fundamentals Why use the Bulk Provisioning ToolFollowing table lists the requirements to run the BPT Bulk Provisioning Tool requirementsApplication Programming Interface fundamentals Install and launch the BPT Using the Bulk Provisioning ToolBPT main menu BPT main menu Quit Files BPT provisioning methodsBPT files and scripts NavigationScripts BPT conventions and examplesMethod and file syntax conventions GetSysRoles optional into file name Optional syntaxBrackets Angle bracketsBar Square bracketsFully qualified user name Comma separated stringsSuccess indication on remove methods Create and manage provisioning roles using the BPT Unknown error messagesDefine the new provisioning role View the new provisioning role AddRole using file D\prov\addexample.txtGetRole using AddExample Add the new provisioning roleDelete the new provisioning role Help addRole BPT Help optionBPT mapping to the Provisioning Client BPT limitationsResource use Batch processingProvisioning data visibility Using the Bulk Provisioning Tool Security, authentication, and authorization Using the Open Provisioning InterfaceSecurity Http Basic Authentication Onboard Authentication AuthenticationWS-Security UsernameToken Special note for .NET authentication headers Domain-level authorization Provisioning-level authorization AuthorizationWsdl Third-party client developmentGet the Wsdl Generate stubsAccess stubs from the third-party application Implement interface accessing stubsStarting the Bulk Provisioning Tool Starting the Bulk Provisioning ToolDownloading the Bulk Provisioning Tool to a workstation Procedure StepsLaunching the BPT on a workstation Launching the BPT on a workstation Starting the Bulk Provisioning Tool Prerequisites for creating OPI clients Creating Open Provisioning Interface clientsCreating OPI clients Task flow for creating OPI clients \axis-14\webapps\axis\WEB-INF\lib Retrieving the error codesDownloading the Axis toolkit Configuring the class pathLoadname/wsdl/opi Downloading the Wsdl fileCompiling the client stubs \opiclientWriting a client to perform some specific OPI operations \opi\serviceExample Writing a client Writing a client to perform some specific OPI operations Compiling the client class Procedure Steps Accessing the OPI Java docsAdminAuthentication subfolder in the OPI Java Docs folder Writing a client to perform some specific OPI operations Accessing the OPI Java docs Tool prompts Trust this certificate? no Importing a CA Certificate into the BPTKeytool -list -v -keystore opitruststore Importing a CA Certificate into the BPT Page Nortel AS
Related manuals
Manual 92 pages 3.24 Kb