|
|
The following sections contain a reference for the management attributes operations and attributes for service provider and application administration. All attributes and operations are available in the managed object ESPA_access in the Network Gatekeeper management console.
Below is a list of management operations related to service provider groups:
Below is a list of management operations related to service provider accounts:
Below is a list of management operations related to application accounts:
Below is a list of management operations related to application groups:
Below is a list of management operations related to application instance group IDs:
Below is a list of attributes and operations for configuration and maintenance:
Displays the number of registered application groups.
Displays the number of registered service provider groups.
Specifies the load percentage that defines when the software module will raise an overloaded alarm. Must be less than Attribute: SevereOverloadPercentage.
Specifies the load percentage that defines when the plug-in will raise a severely overloaded alarm.
Must be larger than Attribute: OverloadPercentage.
Displays the number of registered service provider accounts.
Activate an application account. The application account must be activated before the application can start accessing services in the network.
activateApplicationAccount(serviceProviderAccountID:String, applicationAccountID: String)
Activates an application instance group ID (the application's login username). The application instance group ID must be activated before the application can start accessing services in the network.
activateApplicationInstanceGroup(serviceProviderAccountID:String, applicationAccountID: String, applicationInstanceGroupID: String)
Activates a service provider account. The service provider account must be activated before any of its applications can start accessing services in the network.
activateServiceProviderAccount(serviceProviderAccountID:String)
Creates an application account. The service provider account and the application group to which this application account is to be connected must be created before the application account is created
addApplicationAccount(applicationAccount.serviceProviderAccountID:String, applicationAccount.applicationAccountID: String, applicationAccount.applicationGroupID: String, applicationAccount.applicationRef:String, applicationAccount.properties)
Creates an application group. The application group is associated with an SLA that can be used by one or more application accounts.
addApplicationGroupWithSLAString(applicationGroup.applicationGroupID: String, applicationGroup.slaContents: String,applicationGroup.properties)
Creates an application group. The application group is associated with an SLA that can be used by one or more application accounts.
addApplicationGroupWithSLAUrl(applicationGroup.applicationGroupID: String, applicationGroup.slaContents: String,applicationGroup.properties)
Creates an application instance group ID, which functions as the login username for the application. The parameter applicationInstanceGroup.slaContents must be set to 1.
| Note: | Application instance group IDs must be unique. |
addApplicationInstanceGroupSLAString(serviceProviderAccountID: String, applicationInstanceGroup.applicationAccountID: String, applicationInstanceGroup.applicationInstanceGroupID: String, applicationInstanceGroup.applicationInstanceGroupRef: String, applicationInstanceGroup.slaContents: String, applicationInstanceGroup.properties:, password: String)
Creates a service provider account. The service provider group to which this service provider account is to be connected must be created before the service provider account is created.
addServiceProviderAccount(serviceProviderAccount.serviceProviderAccountID:: String, serviceProviderAccount.serviceProviderGroupID: String, serviceProviderAccount.serviceProviderRef: String, serviceProviderAccount.properties)
Creates service provider group. A service provider group SLA must exist. The SLA is provided as a string.
addServiceProviderGroupWithSLAString(serviceProviderGroup.serviceProviderGroupID: String, serviceProviderGroup.slaContents: String, serviceProviderGroup.properties)
Creates service provider group. A service provider group SLA must exist. A URL to the SLA is provided.
addServiceProviderGroupWithSLAUrl(serviceProviderGroup.serviceProviderGroupID: String, serviceProviderGroup.slaContents: String, serviceProviderGroup.properties)
Deactivates an application account. This deactivates, or temporarily prohibits the flow of traffic to and from, this account's applications.
deactivateApplicationAccount(serviceProviderAccountID: String, applicationAccountID: String)
Deactivates an application instance group ID. Deactivates, or temporarily prohibits the flow of traffic to and from, the application that established a session using this application instance group ID.
deactivateApplicationInstanceGroup(serviceProviderAccountID: String, applicationAccountID: String, applicationInstanceGroupID: String)
Deactivates a service provider account. This deactivates, or temporarily prohibits the flow of traffic to and from, this account's applications.
deactivateServiceProviderAccount(serviceProviderAccountID: String)
Deletes an application account.
| Note: | Deleting an application account also deletes all the application instance group IDs assigned to that account. |
deleteApplicationAccount(serviceProviderAccountID: String, applicationAccountID: String)
deleteApplicationGroup(applicationGroupID: String)
Deletes an application instance group ID.
deleteApplicationInstanceGroup(serviceProviderAccountID: String, applicationAccountID: String, applicationInstanceGroupID: String)
Deletes a service provider account.
| WARNING: | Deleting the service provider account also deletes all related application accounts and application instance group IDs. |
deleteServiceProviderAccount(serviceProviderAccountID: String)
Deletes a service provider group.
| WARNING: | When deleting the service provider group, all related service provider accounts, application accounts and application instance group IDs will also be deleted. |
deleteServiceProviderGroup(serviceProviderGroupID: String)
Deletes a node SLA for a certain service provider group.
deleteServiceProviderGroupNodeSla(serviceProviderGroupID: String)
Displays information about an application account. This information includes the related application group IDs, the application reference, if any, and the account's OAM properties, if any.
getApplicationAccount(serviceProviderAccountID: String, applicationAccountID: String)
Displays information about an application group. The application group's SLA and OAM properties, if any, are displayed.
getApplicationGroup(applicationGroupID: String)
Displays information about an application instance group ID (the login username for the application). The application instance group ID's OAM properties, if any, and application instance group reference are displayed.
getApplicationInstanceGroup(serviceProviderAccountID: String, applicationAccountID: String, applicationInstanceGroupID: String)
Displays information about application instance group ID references.
getNumberOfApplicationInstanceGroupRefs(serviceProviderAccountID: String, applicationAccountID: String, state: int)
Filter on state. See Table 2-1.
|
|
Display the number of application instance group IDs assigned to the application account.
getNumberOfApplicationInstanceGroupsInApplications(serviceProviderAccountID: String, applicationAccountID: String)
Displays the number of application accounts in a certain state.
getNumberOfApplications(serviceProviderAccountID: String, state: int)
State to filter on. See Table 2-1.
|
|
Displays the number of application accounts connected to the application group
getNumberOfApplicationsInApplicationGroup(applicationGroupID: String)
Displays the number of application accounts connected to the service provider.
getNumberOfApplicationsInServiceProvider(serviceProviderAccountID: String)
Displays the number of applications by ID that have sessions established with Network Gatekeeper.
getNumberOfLoggedInApplicationInstanceGroups(serviceProviderAccountID: String, applicationAccountID: String)
Displays the number of application instance group IDs that have sessions established with Network Gatekeeper. Will always be 1.
getNumberOfLoggedInInstancesInInstanceGroup(serviceProviderAccountID: String, applicationAccountID: String, applicationInstanceGroupID: String)
Displays the number of service provider accounts related to a service provider group.
getNumberOfServiceProvidersInGroup(serviceProvidersGroupID: String)
Displays the SLA for an application group.
getSLAForApplicationGroup(applicationGroupID: String)
getSLAForApplicationInstanceGroup(serviceProviderAccountID: String, applicationAccountID: String, applicationInstanceGroupID: String)
Displays the SLA for a service provider group.
getSLAForServiceProviderGroup(serviceProviderGroupID : String)
Displays information about a service provider account. The related service provider group ID, the service provider reference, if any, and the account's OAM properties, if any, are displayed.
getServiceProviderAccount(serviceProviderAccountID : String)
Displays information about a service provider group. The service provider group's SLA and OAM properties, if any, are displayed.
getServiceProviderGroup(serviceProviderGroupID : String)
Displays information about a session. The session is established between an application and Network Gatekeeper.
getSessionInfo(sessionId : String)
Displays information about the state of an application account.
getStateForApplicationAccount(serviceProviderAccountID : String, applicationAccountID: String)
Displays information about the state of an application instance group ID.
getStateForApplicationInstanceGroup(serviceProviderAccountID : String, applicationAccountID: String, applicationInstanceGroupID: String)
Displays information about the state of a service provider account.
getStateForServiceProviderAccount(serviceProviderAccountID : String)
Displays a list of application account IDs related to an application group.
listApplicationAccounts(serviceProviderAccountID : String, state: int, offset: int, length:int)
Filter on state. See Table 2-1.
|
|
Displays a list of application account related to a service provider.
listApplicationAccountsForServiceProvider(serviceProviderAccountID : String, offset: int, length:int)
Displays a list of application account IDs related to an application group.
listApplicationAccountsInGroup(applicationGroupID : String, offset: int, length:int)
Displays a list of application groups.
listApplicationGroups(offset: int, length:int)
Displays a list of application instance group ID references.
listApplicationInstanceGroupRefs(serviceProviderAccountID: String, applicationAccountID: String, state: int, offset: int, length:int)
State to filter on. See Table 2-1.
|
|
Displays a list of application instance group IDs per application account.
listApplicationInstanceGroups(serviceProviderAccountID: String, applicationAccountID: String, offset: int, length:int)
Displays which ESPA services are registered. These are used in backwards compatible traffic paths.
listESPAServices()
Displays a list of application instance group IDs that currently have sessions established with Network Gatekeeper by application accounts.
listApplicationInstanceGroups(serviceProviderAccountID: String, applicationAccountID: String, offset: int, length:int)
Displays a list of service provider accounts.
listServiceProviderAccounts(offset: int, length:int)
Displays the node SLA for service provider group, if any.
listServiceProviderGroupNodeSla(serviceProviderGroupID: String)
Displays a list of service provider groups.
listServiceProviderGroups(offset: int, length:int)
Displays a list of service provider groups that have node SLAs associated.
listServiceProviderGroupsWithNodeSla()
Displays a list of service provider accounts related to a service provider group.
listServiceProvidersInGroup(serviceProviderGroupID: String, offset: int, length:int)
Logs out all applications associated with an application account. De-establish sessions between Network Gatekeeper and the matching applications.
logoutApplicationAccount(serviceProviderAccountID: String, applicationAccountID: String)
Logs out a given application by ID. De-establish the session between Network Gatekeeper and the application.
logoutApplicationInstanceGroup(serviceProviderAccountID: String, applicationAccountID: String, applicationInstanceGroupID: String)
Logs out all applications associated with a service provider account. De-establish sessions between Network Gatekeeper and the matching applications.
logoutServiceProviderAccount(serviceProviderAccountID: String)
Defines a new password for an application instance group ID (the username).
setPasswordForApplicationInstanceGroup(serviceProviderAccountID: String, applicationAccountID: String, applicationInstanceGroupID: String, newPassword : String)
Loads a node SLA for a service provider group.
setServiceProviderGroupNodeSlaString(SLA: String, serviceProviderGroupID: String)
Loads a node SLA for a service provider group.
setServiceProviderGroupNodeSlaUrl(url: String, serviceProviderGroupID: String)
Unlocks an application instance group ID. The application instance group ID (the username) is unlocked and its state is changed to activated. The application instance group ID may be locked because of too many failed login attempts.
unlockApplicationInstanceGroup(serviceProviderAccountID: String, applicationAccountID: String, applicationInstanceGroupID: String)
Change the application group associated with an application account.
updateApplicationAccount(applicationAccount.serviceProviderAccountID: String, applicationAccount.applicationAccountID: String, applicationAccount.applicationGroupID: String, applicationAccount.applicationRef: String, applicationAccount.properties)
Updates the SLA for an application group.
updateApplicationGroupSLAString(applicationGroup.applicationGroupID: String, applicationGroup.slaContents: String, applicationGroup.properties)
Updates the SLA for an application group.
updateApplicationGroupSLAUrl(applicationGroup.applicationGroupID: String, applicationGroup.slaContents: String, applicationGroup.properties)
updateApplicationInstanceGroupSLAString(serviceProviderAccountID: String, applicationInstanceGroup.applicationAccountID: String, applicationInstanceGroup.applicationInstanceGroupID: String, applicationInstanceGroup.applicationInstanceGroupRef: String, applicationInstanceGroup.properties)
Changes the service provider group associated with an service provider account.
updateServiceProviderAccount(serviceProviderAccount.serviceProviderAccountID: String, serviceProviderAccount.serviceProviderGroupID: String, serviceProviderAccount.serviceProviderRef: String, serviceProviderAccount.properties)
Updates the node SLA for a service provider group.
updateServiceProviderGroupNodeSlaString(SLA: String, serviceProviderGroupID: String)
Updates the node SLA for a service provider group.
updateServiceProviderGroupNodeSlaUrl(url: String, serviceProviderGroupID: String)
Updates the SLA for a service provider group.
updateServiceProviderGroupSLAString(serviceProviderGroup.serviceProviderGroupID: String, serviceProviderGroup.slaContents: String, serviceProviderGroup.properties)
Updates the SLA for a service provider group.
updateServiceProviderGroupSLAUrl(serviceProviderGroup.serviceProviderGroupID: String, serviceProviderGroup.slaContents: String, serviceProviderGroup.properties)
|