Namespace "admin"
To use the JavaScript API, you must instantiate an instance of bmm/admin/Admin, specifying the base url of the server to which you want to connect. You then invoke methods on the admin object to perform the operations. Here is an example:
"bmm/admin/Admin"
], function(Admin) {
var admin = new Admin("https://localhost:8443/bmmadmin");
admin.login("admin", "admin");
admin.logout();
admin.close();
});
All main Admin classes can take the base url and provide the login(), logout(), and close() methods. The signatures for these methods are:
login(username, password)
logout()
close()
Project Operations
Get Project
REST
GET /admin/projects/[name]
JavaScript
getProject(name)
Parameters
name – A string representing the name of the project
Returns
A JavaScript object representing the named project
Get Projects
REST
GET /admin/projects/
JavaScript
getProjects()
Parameters
None
Returns
A JavaScript array containing short project definitions (name and description)
Create Project
REST
POST o to /admin/projects/
JavaScript
createProject(o)
Parameters
A JavaScript object representing the project
Returns
None
Modify Project
REST
PUT o to /admin/projects/[name]
JavaScript
modifyProject(o, name)
Parameters
o – A JavaScript object representing the project
name – A string representing the name of the project
Returns
None
Delete Project
REST
DELETE /admin/projects/[name]
JavaScript
deleteProject(name)
Parameters
name – A string representing the name of the project
Returns
None
JSON data format
Project
Field | Description |
|---|---|
name | The name of the project |
description | The description for the project |
connections | An array of connections and their filters associated with the project. The data format for each connection is described in "Project Connection Reference" |
users | An array of user references and their permissions within the project as described in "Project User Reference" |
groups | An array of group references and their permissions within the project as described in "Project Group Reference" |
links | An array of link definitions as described in "Project Links" |
FileAccessEnabled | Specifies whether access to remote resources in the file system as selected for assigned connections should be accessible to project users or not. Valid values are “true” or “false” (note, Boolean so don’t quote) |
Project Connection Reference
Field | Description |
|---|---|
namespace | The namespace for the connection definition (e.g. 'wmq' or 'ems') |
name | The name of the connection |
filters | An array of filter references to be applied to the connection within the project |
Filter Reference
Field | Description |
|---|---|
name | The name of the filter |
namespace | The namespace to which the filter belongs (e.g. 'wmq' or 'ems') |
Project User Reference
Field | Description |
|---|---|
user | The username of a user that is given rights to this project |
permissions | An array of strings specifying the permissions for the user. Valid permissions are "INQUIRE", "DELETE", "READ", "WRITE", "OPERATOR", "ADMINISTRATION" |
Project Group Reference
Field | Description |
|---|---|
group | The name of a group that is given rights to this project |
permissions | An array of strings specifying the permissions for the user. Valid permissions are "INQUIRE", "DELETE", "READ", "WRITE", "OPERATOR", "ADMINISTRATION" |
Project Link Reference
Field | Description |
|---|---|
name | The name to be given to the link |
url | The url for the link |
User Operations
Get User
REST
GET /admin/users/[name]
JavaScript
getUser(name)
Parameters
name – A string representing the name of the user
Returns
A JavaScript object representing the named user
Get Users
REST
GET /admin/users/
JavaScript
getUsers()
Parameters
None
Returns
A JavaScript array containing user definitions
Create User
REST
POST o to /admin/users/
JavaScript
createUser(o)
Parameters
o – A JavaScript object representing the user
Returns
None
Modify User
REST
PUT o to /admin/users/[name]
JavaScript
modifyUser(o, name)
Parameters
o – A JavaScript object representing the user
name – A string representing the name of the user
Returns
None
Delete User
REST
DELETE /admin/users/[name]
JavaScript
deleteUser(name)
Parameters
name – A string representing the name of the user
Returns
None
JSON data format
Field | Description |
|---|---|
username | The username that identifies the user |
enabled | Specifies whether the user is allowed to login or not. Valid values are "true" or "false" (note, boolean, so don't quote). |
fullname | The full name of the user |
The email address of the user | |
password | The password of the user. Please leave this empty for read operations. |
set_password | When setting a password, this must be boolean true and the password must be specified in clear text. |
Group Operations
Get Group
REST
GET /admin/groups/[name]
JavaScript
getGroup(name)
Parameters
name – A string representing the name of the group
Returns
A JavaScript object representing the named group
Get Groups
REST
GET /admin/groups/
JavaScript
getGroups()
Parameters
None
Returns
A JavaScript array containing group definitions
Create Group
REST
POST o to /admin/groups/
JavaScript
createGroup(o)
Parameters
o – A JavaScript object representing the group
Returns
None
Modify Group
REST
PUT o to /admin/group/[name]
JavaScript
modifyGroup(o, name)
Parameters
o – A JavaScript object representing the group
name – A string representing the name of the group
Returns
None
Delete Group
REST
DELETE /admin/groups/[name]
JavaScript
deleteGroup(name)
Parameters
name – A string representing the name of the group
Returns
None
JSON data format
Field | Description |
|---|---|
name | The name of the group |
descr | The description of the group |
members | An array of usernames who are members of the group |
Filter Operations
Get Filter
REST
GET /admin/filters/[name]?filtertype=[filtertype]
JavaScript
getFilter(name, query)
Parameters
name - A String representing the filter name
query – A JavaScript object that contains “filtertype” string as a key. The value can be PROPERTIES_FILTER, WILDCARD_FILTER or LOGICALEX_FILTER
Returns
A JavaScript object representing the named filter of the specific type.
Get Filters
REST
GET /admin/filters/
JavaScript
getFilters()
Parameters
None
Returns
A JavaScript array containing filter definitions
Create Filter
REST
POST o to /admin/filters/
JavaScript
createFilter(o)
Parameters
o – A JavaScript object representing the filter
Returns
None
Modify Filter
REST
PUT o to /admin/filter/[name]
JavaScript
modifyFilter(o, name)
Parameters
o – A JavaScript object representing the filter
name – A string representing the name of the filter
Returns
None
Delete Filter
REST
DELETE /admin/filters/[name]?filtertype=[filtertype]
JavaScript
deleteFilter(name, query)
Parameters
name – A String representing the filter name
query – A JavaScript object that contains “filtertype” string as a key. The value can be PROPERTIES_FILTER, WILDCARD_FILTER or LOGICALEX_FILTER
Returns
None
Get Filter Associations
REST
GET /admin/filters/[name]/assignments?type=[filtertype]
JavaScript
getFilterAssociations(name, type)
Parameters
name - A String representing the filter name
type – A String representing the filter's type. The value can be PROPERTIES_FILTER, WILDCARD_FILTER or LOGICALEX_FILTER
Returns
A JavaScript array containing filter associations.
JSON data format
Field | Description | Note |
|---|---|---|
name | The name of the filter | None |
type | A string representing the type of filter. "WILDCARD_FILTER" , "PROPERTIES_FILTER" and "LOGICALEX_FILTER" are the valid types. | None |
Namespace | The namespace to which the obj_type belongs (e.g. 'wmq' or 'ems') | None |
filter_expr | The filter expression | Valid only for filters from types WILDCARD_FILTER, LOGICALEX_FILTER |
obj_type | The type of object to which the filter applies. The valid types are: “QueueManager”, “Comminfo”, “Connection”, “AuthorityRecord”, “ChannelAuthRecord”, ”Cluster”, “Message”, “StorageClass”, "Queue", "Channel", "Process", "Subscription", "Topic", "Listener", "Namelist", "Service", "Authinfo" | “QueueManager”, “Connection”, “AuthorityRecord”, “ChannelAuthRecord”, ”Cluster”, “Message” are relevant only for filter of type PROPERTIES_FILTER |
properties | The filter properties | Valid only for filter from type PROPERTIES_FILTER |
disableObjType | Disable Object Type, valid values are true or false | Valid only for filter from type PROPERTIES_FILTER |
permission | The filter permission, valid values are INQUIRE, OPERATOR, ADMINISTRATION | Valid only for filter from type PROPERTIES_FILTER |
WMQConnection Operations
Get WMQConnection
REST
GET /wmq/connections/[name]
JavaScript
getWMQConnection(name)
Parameters
name – A string representing the name of the connection
Returns
A JavaScript object representing the named connection
Get WMQConnections
REST
GET /wmq/connections/
JavaScript
getWMQConnections()
Parameters
None
Returns
A JavaScript array containing connection definitions
Create WMQConnection
REST
POST o to /wmq/connections/
JavaScript
createWMQConnection(o)
Parameters
o – A JavaScript object representing the connection
Returns
None
Modify WMQConnection
REST
PUT o to /wmq/connections/[name]
JavaScript
modifyWMQConnection(o, name)
Parameters
o – A JavaScript object representing the connection
name – A string representing the name of the connection
Returns
None
Delete WMQConnection
REST
DELETE /wmq/connections/[name]
JavaScript
deleteWMQConnection(name)
Parameters
name – A string representing the name of the connection
Returns
None
JSON data format
Field | Description |
|---|---|
name | The name of the connection |
qmgr | The name of the queue manager for this connection |
host | The host where the queue manager resides |
port | The port used to connect to the queue manager on the host where the queue manager resides |
channel | The name of a IBM MQ server connection channel to use to connect to the queue manager |
sslenabled | Specifies whether SSL is required for this connection. If unspecified, false is assumed. |
ciphersuite | The cipher suite to use when using SSL |
proxyenabled | Whether this queue manager is accessed via a queue manager proxy. If unspecified, false is assumed. |
qmgrproxy | The queue manager proxy to use if proxying |
securityexitenabled | Whether this connection requires a security exit. If unspecified, false is assumed. |
securityexitlibname | The name of the library for the security exit |
securityexitentrypoint | The entry point of the security exit |
securityexitdata | Data to be passed to the security exit if required |
commandinputqueue | The name of the command input queue. Note, if using the default, this can be left unspecified and generally should be left unspecified |
commandreplymodelqueue | The name of the queue to use for replies from the command server. Note, if using the default, this can be left unspecified and generally should be left unspecified |
monitoringenabled | If true, this queue manager will be monitored. If left unspecified, false is assumed. |
Indexingenabled | If true, this queue manager will be indexed for searches. If left unspecified, false is assumed. |
Indextype | The type of indexing, 0 means once daily and 1 means periodic |
indexinterval | If indextype is 0 (once daily), then this is the hour of the day to index from 0 to 23. If index type is 1 (periodic), then this is the periodicity (e.g. 2 means index every second hour) |
isMainframe | Indicates whether or not the queue manager is hosted on a z/OS mainframe. false assumed as the default when omitted. |
isDisabled | If this field is unspecified, it is considered as false whether the connection is enabled or not. |
maxconnections | Maximum number of connections MVMA can have to a single unique queue manager configuration (hostname!qmgr!channel!port). The default value is 10 unique connections. |
maxidletime | Maximum seconds MVMA will wait before expiring an idle queue manager connection. The default is 600 seconds or 10 minutes (note that a non-positive value enforces the default). |
connectionproperties | A JSON object with the names of custom java properties relevant to the connection as the keys and the key’s values being set to the intended property values. |
username | The username MVMA should use for authentication when connecting to a queue manager where connection authentication is enabled. |
password | The username MVMA should use for authentication when connecting to a queue manager where connection authentication is enabled (masked when reading the connection). |
OverrideCredentials | Whether or not to require the requesting user to provide credentials for authenticating the connection to the remote queue manager system for specific operations such as messaging. These credentials would override the credentials configured for the connection. |
FileAccessScheme | The protocol MVMA should use to access the file system on the remote queue manager system. Select 0 to Auto-detect, 1 for SMB and 2 for SSH/SFTP. |
FileAccessPort | The port used to access the remote queue manager system. SSH/SFTP defaults to port 22 and SMB defaults to port 445. |
FileAccessUser | The username required to access the remote system that hosts the queue manager. |
FileAccessPassword | The password required to access the remote system that hosts the queue manager. |
WmqErrorDir | The path to the global MQ error directory on the remote system |
WmqIni | The path to the MQ installation’s mqs.ini configuration file. |
QmgrLogDir | The path to the remote queue manager’s log directory |
QmgrErrorDir | The path to the remote queue manager’s error directory |
QmgrRootDir | The path to the remote queue manager’s root directory |
QmgrIni | The path to the remote queue manager’s QM.INI file |
CustomDirs | A JSON object with the key being an identifying name for the remote directory and the value being the path to the remote directory. |
ExecutionType | The type of execution process to be used while executing MQ commands on the remote system.
|
ExecutionPath | The execution path when ExecutionType is set to Execution Path. |
ExecutionPlatform | The platform of the remote system to consider for MQ command execution. Select 0 for Unix, 1 for Windows, 2 for AIX or 3 for OS/400. |
EMSConnection Operations
Get EMSConnection
REST
GET /ems/connections/[name]
JavaScript
getEMSConnection(name)
Parameters
name – A string representing the name of the connection
Returns
A JavaScript object representing the named connection
Get EMSConnections
REST
GET /ems/connections/
JavaScript
getEMSConnections()
Parameters
None
Returns
A JavaScript array containing connection definitions
Create EMSConnection
REST
POST o to /ems/connections/
JavaScript
createEMSConnection(o)
Parameters
o – A JavaScript object representing the connection
Returns
None
Modify EMSConnection
REST
PUT o to /ems/connections/[name]
JavaScript
modifyEMSConnection(o, name)
Parameters
o – A JavaScript object representing the connection
name – A string representing the name of the connection
Returns
None
Delete EMSConnection
REST
DELETE /ems/connections/[name]
JavaScript
deleteEMSConnection(name)
Parameters
name – A string representing the name of the connection
Returns
None
JSON data format
Field | Description |
|---|---|
name | The name of the connection |
url | The url used to connect to the TIBCO EMS server |
username | The administrative username to use when connecting |
password | The administrative password to use when connecting |
indexing_enabled | If true, this TIBCO EMS server will be indexed for searches. If left unspecified, false is assumed. |
Index_type | The type of indexing, 0 means once daily and 1 means periodic |
index_interval | If indextype is 0 (once daily), then this is the hour of the day to index from 0 to 23. If index type is 1 (periodic), then this is the periodicity (e.g. 2 means index every second hour) |
ssl_auth_only | |
ssl_debug_trace | |
ssl_enabled | |
ssl_identity_encoding | |
ssl_keystore | |
ssl_keystore_location | |
ssl_keystore_password | |
ssl_private_key_encoding | |
ssl_trace | |
ssl_truststore | |
ssl_truststore_location | |
ssl_truststore_password | |
ssl_verify_host | |
ssl_verify_hostname | |
isDisabled | Whether or not the connection is disabled. If unspecified, false is assumed. |
ssl_password | The password for the SSL private key. Masked when reading the connection properties. |
ssl_expected_hostname | The hostname the EMS Server is expected to use in an SSL connection. |
FileAccessScheme | The prototocol MVMA should use to access the file system on the remote queue manager system. Select 0 to Auto-detect, 1 for SMB and 2 for SSH/SFTP |
FileAccessPort | The port used to access the remote queue manager system. SSH/SFTP defaults to port 22 and SMB defaults to port 445 |
FileAccessUser | The username required to access the remote system that hosts the queue manager. |
FileAccessPassword | The password required to access the remote system that hosts the queue manager. |
SrvLogDir | The path to the EMS server’s log directory |
SrvRootDir | The path to the EMS server’s root directory |
SrvConf | The path to the EMS server’s configuration file |
CustomDirs | A JSON object with the key being an identifying name for the remote directory and the value being the path to the remote directory. |
Event Rule Operations
Get Event Rule
REST
GET /wmq/events/[project]/rules/[name]
JavaScript
getEventRule(project, name)
Parameters
project – A string representing the project name to which the rule belongs
name – A string representing the name of the event rule
Returns
A JavaScript object representing the named event rule
Get Event Rules
REST
GET /wmq/events/[project]/rules/
JavaScript
getEventRules()
Parameters
Project – A string representing the project name to which the event rule belongs
Returns
A JavaScript array containing event rules for the specified project
Create Event Rule
REST
POST o to /wmq/events/[project]/rules/
JavaScript
createEventRule(project, o)
Parameters
project – A string representing the project name to which the rule belongs
o – A JavaScript object representing the event rule
Returns
None
Modify Event Rule
REST
PUT o to /wmq/events/[project]/rules/[name]
JavaScript
modifyEventRule(project, o, name)
Parameters
project – A string representing the project name to which the rule belongs
o – A JavaScript object representing the event rule
name – A string representing the name of the event rule
Returns
None
Delete Event Rule
REST
DELETE /wmq/events/[project]/rules/[name]
JavaScript
deleteEventRule(project, name)
Parameters
project – A string representing the project name to which the rule belongs
name – A string representing the name of the event rule
Returns
None
JSON data format
Event Rule
Field | Description |
|---|---|
rulename | The name of the rule. |
level | A number representing the severity of the event. Valid values are: |
trigger | A number representing the trigger type (see triggers below). |
objectname | A string representing the object name to which this rule applies. This value may be a generic name (e.g. QUEUE.AAA*). |
projectname | A string representing the name of the project to which this rule belongs. |
connection | A string representing the name of a connection within the project to which this rule applies. This value may be a generic name (e.g. MYQMCONN*). |
excludename | A string representing an object name to exclude from application of the rule. This value may be a generic name (e.g. QUEUE.AAA*). |
occurrences | A number representing the number of times this condition holds before the event becomes active. |
action | A number representing the action to take when the event becomes active. Valid values are: |
actionrerun | A number representing the number of minutes between re-running the action while the event is active. |
effectivedays | A string containing a comma-separated list of days (by name) for which this event is effective. For instance, specifying "Monday,Tuesday" means the event will only be active on Monday and Tuesday. Valid values for day names are "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", and "Sunday". |
effectivestart | A number representing the beginning time for which this event can be active. The number is specified in minutes since midnight. For example, 360 would indicate that this event would be active beginning at 6:00 AM. |
effectiveend | A number representing the ending time for which this event can be active. The number is specified in minutes since midnight. For example, 1080 would indicate that this event would be active ending at 6:00 AM. |
Trigger Definitions
Trigger ID | Description | Field | Description |
|---|---|---|---|
1001 | QueueMoreThanNPercentFull | percentage | A number representing the depth as a percentage vs. max depth |
1002 | QMgrNotAccessible | ||
1003 | MessageInDLQ | ||
1004 | QueueFull | ||
1005 | CommandServerDown | ||
1006 | XmitQueueNotServiced | ||
1007 | ChannelRetryingXmitQNotEmpty | ||
1008 | ChannelRetrying | ||
1009 | ChannelInDoubt | ||
1010 | ChannelStopped | ||
1011 | QueueMoreThanNMessages | messagecount | A number representing the number of messages on a queue |
1012 | QueueMoreThanNMessagesNoReaders | messagecount | A number representing the number of messages on a queue |
1013 | QueueMoreThanNPercentFullNoReaders | percentage | A number representing the depth as a percentage vs. max depth |
1014 | QueueLessThanNReaders | readercount | A number representing the number of readers on a queue |
1015 | QueueLessThanNWriters | writercount | A number representing the number of writers on a queue |
1016 | ServerConnActiveInstancesMoreThanN | channelcount | A number representing the number of channelinstances |
1017 | TotalRunningChannelCountMoreThanN | channelcount | A number representing the number of channelinstances |
1018 | XmitQueueMoreThanNMessages | messagecount | A number representing the number of messages on a queue |
1019 | XmitQueueMoreThanNPercentFull | percentage | A number representing the depth as a percentage vs. max depth |
1020 | FirstMessageOnQueueMoreThanNSeconds | seconds | A number representing the number of seconds that the first message has been on the queue |
1021 | OldestMessageOnQueueMoreThanNSeconds | seconds | A number representing the number of seconds that the oldest message has been on the queue |
1022 | OldestMessageOnXmitQMoreThanNSeconds | seconds | A number representing the number of seconds that the oldest message has been on the queue |
1023 | TriggerMonitorDown | readercount | A number representing the number of readers on the trigger initiation queue |
1024 | ChannelInitiatorDown | readercount | A number representing the number of readers on the channel initiator queue |
Security Operations
Get Security
REST
GET /admin/security
JavaScript
getSecurity()
Parameters
None
Returns
A JavaScript object representing the MVMA security settings.
Modify Security
REST
PUT o to /admin/ security
JavaScript
modifySecurity(o)
Parameters
o – A JavaScript object representing the MVMA security settings
Returns
None
JSON data format
Field | Description |
|---|---|
admin.security.model | On GET a String representation of the selected MVMA Security Model. On PUT an Integer representing the MVMA Security Model: 0 – for ADMIN_ADMIN 1 – for LDAP_ADMIN 2 – for LDAP_LDAP 3 – for PREAUTH_ADMIN 4 – for PREAUTH_LDAP Valid for all security models. |
ldap.url | A String representing the URL for connecting to the LDAP Server Valid for security models LDAP_LDAP, LDAP_ADMIN and PREAUTH_LDAP |
ldap.manager.dn | A String representing the DN of a user which can read entries in the LDAP directory. Valid for security models LDAP_LDAP, LDAP_ADMIN and PREAUTH_LDAP |
ldap.manager.password | A String representing the password for the LDAP manager user DN Valid for security models LDAP_LDAP, LDAP_ADMIN and PREAUTH_LDAP |
ldap.user.searchbase | A String representing the base DN from which the searches for user information occur. Valid for security models LDAP_LDAP, LDAP_ADMIN and PREAUTH_LDAP |
ldap.user.searchfilter | A String representing the search filter used to identify users. Valid for security models LDAP_LDAP, LDAP_ADMIN and PREAUTH_LDAP |
ldap.users.searchfilter | A String representing the search filter used to find users within the directory Valid for security models LDAP_LDAP and PREAUTH_LDAP |
ldap.username.attribute | A String to be used by MVMA to identify the text to use as the username. Valid for security models LDAP_LDAP and PREAUTH_LDAP |
ldap.group.searchbase | A String representing the base DN used to search for groups. Valid for security models LDAP_LDAP and PREAUTH_LDAP |
ldap.group.searchfilter | A String representing the search filter used to find groups by name. Valid for security models LDAP_LDAP and PREAUTH_LDAP |
ldap.groupmember.attribute | A String representing the attribute that represents a member of a group in LDAP/AD Valid for security models LDAP_LDAP and PREAUTH_LDAP |
ldap.groupmember.searchfilter | A String representing the search filter expression used to determine members of groups. Valid for security models LDAP_LDAP and PREAUTH_LDAP |
ldap.groupname.attribute | A String representing the attribute holding the name of a group in LDAP/AD Valid for security models LDAP_LDAP and PREAUTH_LDAP |
ldap.groups.searchfilter | A String representing the search filter expression that returns group names. Valid for security models LDAP_LDAP and PREAUTH_LDAP |
ldap.max.nestedgroups.recursion.level | An Integer as a String representing the limit for the amount of recursions used to find nested groups. Valid for security models LDAP_LDAP and PREAUTH_LDAP |
preauth.principal.header | A String representing the header containing authentication information for the requesting principal. Valid for security models PREAUTH_ADMIN and PREAUTH_LDAP |
preauth.proxy.server.addr | A String representing the name or address of the server to proxy MVMA authentication requests to. Valid for security models PREAUTH_ADMIN and PREAUTH_LDAP |
Settings Operations
Get Settings
REST
GET /admin/settings
JavaScript
getSettings ()
Parameters
None
Returns
A JavaScript object representing the settings
Modify Settings
REST
PUT o to /admin/settings
JavaScript
modifySettings(o)
Parameters
o – A JavaScript object representing the settings
Returns
None
JSON data format
Field | Description |
|---|---|
ArchiveInterval | An Integer as a String representing the archiving interval in minutes |
ArchiveMaxCount | An Integer as a String representing the maximum number of archive files to keep |
ArchiveNotificationMailAddress | A String with the e-mail address of the recipient for notifications of archiving failures |
BrowserSessionTimeout | An Integer as a String representing a time interval (in minutes) after which a user is logged out of the MVMA web UI automatically when being idle for this amount of time. |
MonitoringInterval | An Integer as a String representing the number of seconds between MVMA Monitoring cycles |
MonitorNotificationMailAddress | A String with the e-mail address of the recipient for notifications of monitoring failures |
SMTPFromAddress | A String with the originating e-mail address being used for MVMA e-mail notifications |
SMTPHost | A String representing the name of the SMTP server to use for sending email notifications |
SMTPPort | An Integer as a String representing the SMTP server’s port number |
Product Administrators Operations
Get Product Administrators
REST
GET /admin/administrators
JavaScript
getAdministrators()
Parameters
None
Returns
A JavaScript object representing the (user and group) assignments to the Product Administrator role.
Modify Product Administrators
REST
PUT o to /admin/administrators
JavaScript
updateAdministrators (o)
Parameters
o – A JavaScript object representing the product administrators
Returns
None
JSON data format
Field | Description |
|---|---|
administrators | An array of strings with the names of the users assigned the Product Administrator role |
administratorgroups | An array of strings with the names of the groups assigned the Product Administrator role |
Product Key Operations
Get Product Key
REST
GET /admin/productkeys/installKey
JavaScript
Not supported
Parameters
None
Returns
A JavaScript object representing the decoded MVMA product key.
Create or Install Product Key
REST
POST o to /admin/productkeys/installKey
JavaScript
installKey(o)
Parameters
o – A JavaScript object representing the encoded MVMA product key
Returns
None
Modify Product Key
REST
PUT o to /admin/productkeys/installKey
JavaScript
Not supported
Parameters
o – A JavaScript object representing the encoded MVMA product key
Returns
None
Delete Product Key
REST
DELETE /admin/productkeys/installKey
JavaScript
Not supported
Parameters
None
Returns
None
JSON data format
Field | Description |
|---|---|
product_key | The encoded MVMA product key as a String Valid only for Create/Modify Product Key |
product_key_id | The MVMA product key identifier as a String. Must be ‘installKey’. Valid only for Create/Modify Product Key. |
com.bmc.license.company | A String representing the company the product key was licensed to Valid only for GET. |
com.bmc.license.product | A String representing the MVMA product name the product key was created for Valid only for GET. |
com.bmc.license.product.number | An Integer representing the product number the product key was created for. Valid only for GET. |
com.bmc.license.expiration_date | An Integer representing the expiration date for the product key (in milliseconds). Valid only for GET. |
com.bmc.license.mmadmin.wmq.queue_managers | An Integer as a String representing the number of licensed IBM MQ Queue Managers Valid only for GET. |
com.bmc.license.mmadmin.ems.servers | An Integer as a String representing the number of licensed Tibco EMS servers Valid only for GET. |
com.bmc.license.created | An Integer representing the timestamp for when the product key was created (in milliseconds) Valid only for GET. |
Version Operations
Get Version
REST
GET /admin/version
JavaScript
getVersion()
Parameters
None
Returns
A JavaScript object with version information for the MVMA installation.
JSON data format
Field | Description |
|---|---|
ProductName | A String representing the installed product’s name. |
ProductVersion | A String representing the installed product’s version. |
BundleVersion | A String representing the OSGi bundle version used with the installed product. |
Message Format Script Operations
Get Message Format Scripts
REST
GET /admin/messageformatscripts
JavaScript
Not supported
Parameters
None
Returns
A JavaScript array containing the message format script definitions
Create Message Format Script
REST
POST o to /admin/messageformatscripts?name=[name]&description=[descr]
JavaScript
Not supported
Parameters
name – the name for the Message Format Script (as a query parameter)
descr – the description for the Message Format script (as a query parameter)
o – the file containing the Message Format Script for upload
Returns
None
Modify Message Format Script (Properties only)
REST
PUT o to /admin/messageformatscripts/[name]
JavaScript
Not supported+
Parameters
name – A string representing the name of the Message Format Script
description – the description for the Message Format script (as a query parameter)
o – a JavaScript object with ‘description’ as the key
Returns
None
Modify Message Format Script (Contents and Properties)
REST
POST o to /admin/messageformatscripts/[name]?description=[descr]
JavaScript
Not supported
Parameters
name – A string representing the name of the Message Format Script
descr – the description for the Message Format script (as a query parameter)
o – a JavaScript object representing the message format rule
Returns
None
Delete Message Format Script
REST
DELETE /admin/messageformatscripts/[name]
JavaScript
Not supported
Parameters
None
Returns
None
JSON data format
Field | Description |
|---|---|
name | The name of the Message Format Script |
description | A description for this Message Format Script |
contents | The (JavaScript) content of the Message Format Script |
Message Format Rule Operations
Get Message Format Rules
REST
GET /admin/messageformatrules
JavaScript
Not supported
Parameters
None
Returns
A JavaScript array containing the message format rule definitions
Create Message Format Rule
REST
POST o to /admin/messageformatrules
JavaScript
Not supported
Parameters
o – A JavaScript object representing the message format rule
Returns
None
Modify Message Format Rule
REST
PUT o to /admin/messageformatrules/[name]
JavaScript
Not supported
Parameters
name – A string representing the name of the message format rule
o – A JavaScript object representing the message format rule
Returns
None
Delete Message Format Rule
REST
DELETE /admin/messageformatrules/[name]
JavaScript
Not supported
Parameters
name – A string representing the name of the message format rule
Returns
None
JSON data format
Field | Description |
|---|---|
name | The name of the Message Format Rule |
description | A description for this Message Format Rule |
format | The relating message format |
scriptName | The relating Message Format Script |
eyeCatcher | A string as an eyecatcher to identify messages applying to the rule |
Login Icon Operations
Get Login Icon
REST
GET /admin/icons/customLogin
JavaScript
Not supported
Parameters
None
Returns
The icon’s image data.
Get Login Icons
REST
GET /admin/icons/
JavaScript
Not supported
Parameters
None
Returns
A JavaScript array containing the login icon definitions
Create Login Icon
REST
POST o to /admin/icons/?name=customLogin&description=[descr]&height=82px&width=270px
JavaScript
Not supported
Parameters
descr – the description for the Message Format script
height – the icons height (currently fixed to 82px)
width – the icon’s width (currently fixed to 270px)
o – the file containing the icon image data for upload
Returns
None
Modify Custom Icon
REST
POST o to /admin/icons/customLogin&description=[descr]&height=82px&width=270px
JavaScript
Not supported
Parameters
descr – the description of the icon definition
height – the icon definition’s height (currently fixed to 82px)
width – the icon definitions’s width (currently fixed to 270px)
o – the file containing the icon image data for upload
Returns
None
Delete Custom Icon
DELETE /admin/icons/customLogin
JavaScript
Not supported
Parameters
None
Returns
None
JSON data format
Field | Description |
|---|---|
name | The name of the icon definition |
description | The description of the icon definition |
height | The icon definition’s height (currently fixed to 82px) |
width | The icon definition’s width (currently fixed to 270px) |
dataSize | The size of the icon’s image data (in bytes) (read-only) |
MQSC Authorities Operations
Get MQSC Authorities
REST
GET /wmq/mqscauthorities
JavaScript
getMQSCAdministrators()
Parameters
None
Returns
A JavaScript array containing the names of the users assigned the MQSC Console Administrator role
Modify MQSC Authorities
REST
PUT o to /wmq/mqscauthorities
JavaScript
modifyMQSCAdministrators(o)
Parameters
o – A JavaScript object representing the users assigned the MQSC Console Administrator role
Returns
None
JSON data format
Field | Description |
|---|---|
mqscauthorities | An array with the names of the users assigned to the MQSC Console Administrator role |