The cluster name the account was found on. Values tied to it match above values.
"created":
date
The date the account was inserted into database.
"gecos":
string
The 5th field of the /etc/passwd file, better known as short description of the account.
"gid":
int
The gid numeric value to use for the group name in the "group" value
"group":
string
The name of the group to use for the primary group for the account
"group_file":
string
The line to add to the /etc/group file to match the gid in the /etc/passwd file.
"home":
string
The home directory used for the account.
"ldap":
int
If the account was an LDAP account, the LDAP ID associated to it.
"passwd_file":
string
The line to add to the /etc/passwd file.
"shell":
string
The shell to use for the account.
"status":
string
Message returned if trying to create the account(related to status_id field)
"status_id":
int
When creating, whether it worked or not. [0 = Created, 1 = Failed]
"tool":
string
The Account Tool name that is managing the account
"uid":
int
The uid numeric value to use for the unix account
"unix_id":
string
The login id for the linux/unix server.
Parameters
Parameter
Value
Description
account:
string
The account name to lookup, if pure numeric, the account will assume to be an LDAP account
create:
string
Set to any value to create the account if it does not exist
custom:
string
A 6 part string of custom values for creating the account(unix account:uid:group name:gecos:home:shell). Leave any value blank to accept defaults.
debug:
string
Set to any value to debug - Used with the "create" option
gid:
int
The group gid value to use when creating the account (optional)
search_uid:
string
Find all accounts that use the uid value specified for this option.
show:
string
Values that can be used: [ ALL | PASSWD | GLOBAL ]
ALL: Shows all clusters/management tools and settings the account uses
PASSWD: Shows the best line to use for /etc/passwd and /etc/group files
GLOBAL:will show the global values for the account to parse for whatever reason.
svr_name:
string
The name of the specific server to look up information on the account for
system_id:
int
The Account tool ID value to search on ONLY. This value is optional, and will search all account tools if not set. For Account tool values to use, refer to the values listed under the "Account Mgmt" menu item, under the "Account Tools" selction item. When selecting an account tool, below it will refer to a systemID value to reference.
Example CURL Command: If using "master", set it to any value
Any additional information added when this record was created.
"darth":
string
The name of the DARTH tool supporting this record
"darth_url":
string
The URL of the DARTH tool supporting this record
"date_created":
string
When was the record created
"flag_description":
string
Description of the flag setting, if a flag was used.
"not_pingable_since":
string
The date the record hasn't pinged since, if set.
"owner":
string
Who created the record
"support_pxe":
flag
t = true,f = false
"ttl":
int
The Time To Live setting for the record
"type":
string
Record Type, being a PTR, A, CNAME, etc
Parameters
Parameter
Value
Description
domain:
string
The record defined here will return back the DARTH that is managing it.
ip:
string
The record given here will return back the DARTH that is managing it.
limit:
int
the number of devices to retrieve. Specify 0 to return all
record:
string
Filter the list by the record name.
sortBy:
sortBy
Sort the returned records by one of the following attributes: owner, dateCreated, recordName. Prefix the attribute with a + for ascending or - for descending.
type:
string
Filter the list by the record type. ( i.e. PTR|A|CNAME|MX|RP|TXT )
Implementation Notes This REST API provides the ability to query and create account or group information with a unique UID or GID value. If a match is found, that match is returned. If no match is found, then an entry is created, and that creation is returned. The status ID code will reflect the results of what has happened.
You can also provide the "flagError" value to tell the call to error if it does not return the request as asked for, rather then returning what fits the dictionary values. If the flag is not used, a result will ALWAYS be returned, whether it matched the requested items or not. This is useful if you are not sure of what values to use, but in case the account/group doesn't exist, you can request those items. If a match is found, then those items are ignored, unless they match a unique set, in which case that set of data is returned.
This script also takes an argument to show other potential matches to the account or group. This supports cases where Oracle may have 2 different group names(dba and uoid), and you may need one type of account, or another to support the Oracle 12g software, or older legacy software. This option can also be used to review all other configurations for the account/group in case an account matching an account tool is desired over the global uid/gid value to support legacy servers.
The "showResults" argument can be used to return the data in certain types of formats, which can be used to insert the data directly into account tools, or just read specific pieces of information for the account/group given.
If you provide extra values in your request, if a match is found, a "custom" section will be returned matched your request. The "prefer" values will always be returned in case the extra search items match or not.
Required fields: unixID | groupID
Response Information
"gecosName":
string
The 5th field of the /etc/passwd file, better known as short description of the account.
"gidID":
int
The GID value the unixID/groupID should use.
"globalID":
int
If there was an entry in the global table, this will be set to the unique ID value.
"groupID":
string
The group value that was used to search on.
"groupName":
string
The group name to use for the unixID value in /etc/group
"homeDir":
string
The home directory the unixID should use.
"shellPath":
string
The shell to use for the unixID.
"statusDesc":
string
Message returned to match the statusID value.
"statusID":
int
Response will either be [ 1 = account/group created, 2 = query found, 3 = query found, but not match optional items, 4 = query found, custom match made, 5 = query could not match to custom values, 8 = known error/issue, 9 = failed to query/create ]
"uidID":
int
The UID value the unixID should use.
"unixID":
string
The account value that was used to search on.
Parameters
Parameter
Value
Description
debug:
boolean
Default is "f". Set to "t" to debug the command. If set to "t", no database creation/updates are made, and no logging is done. This option allows you to run the command over and over without changing anything in the database.
flagError:
boolean
Default is "f". Set to "t" to utilize this value. If the rest call cannot be completed, as requested, throw an error rather then return information about the unixID/groupID
gecosName:
string
The 5th field of the /etc/passwd field. Can be used for matching as well. (optional)
gidID:
int
The GID of the group desired/matched too. (optional)
groupID:
string
The name of the group to lookup/create.
groupName:
string
The name of the group the unixID should use. Used in conjunction with gidID value. (optional)
homeDir:
string
The unixID desired/matched home directory path. (optional)
shellPath:
string
The desired/match shell to use. (optional)
showResults:
string
Values that can be used: [ mkacct | tesla | linux | extras ]
mkacct: Returns the strings to plug directly into mkacct files
tesla: Returns tesla object
linux: Returns the lines to directly insert into /etc/passwd-/etc/group files.
extras: If the account has multiple matches, return the other variations of the account/group and the settings
If left blank, will return a json data object.
uidID:
int
The UID of the account desired/matched too. (optional)
unixID:
string
The account name to lookup/create, if pure numeric, the account will assume to be an LDAP account
The cluster name the group was found on. Values tied to it match above values.
"error":
string
If something is wrong with the request, what it was.
"gid":
int
The gid value for the group
"group":
string
The value that was used to search on.
"group_file":
string
The line to add to the /etc/group file to match the gid in the /etc/passwd file.
"status_id":
int
When used with create option, the results of the creation
"success":
string
When used with create option, the message about the creation.
"tool":
string
The Account Tool name that is managing the group
Parameters
Parameter
Value
Description
create:
string
Create the group if it doesn't exist. Set to any value to use.
debug:
string
Used with the "create" option, set to any value to NOT do database updates and see what response would be.
gid:
int
When used with the create option, the gid to use for the group name in the "group" value to create.
group:
string
The group name to lookup
search_gid:
string
Find all groups using the gid value set here.
show:
string
Values that can be used: [ ALL | PASSWD | GLOBAL ]
ALL: Shows all clusters/management tools and settings the group uses
PASSWD: Shows the best line to use for /etc/group file
GLOBAL:will show the global values for the group to parse for whatever reason.
system_id:
int
The Account tool ID value to search on ONLY. This value is optional, and will search all account tools if not set. For Account tool values to use, refer to the values listed under the "Account Mgmt" menu item, under the "Account Tools" selction item. When selecting an account tool, below it will refer to a systemID value to reference.
The return message for request, whether fail or success.
"statusID":
int
The return code for request, 1 = SUCCESS, 2 = NOTHING FOUND, 5 > = APP ISSUE
"svrName":
string
The name of the server for the array item
Parameters
Parameter
Value
Description
action:
string
What action to perform - [QUERY|ENABLE|DISABLE]
pass:
string
The password for the user parameter.
serverList:
array
The name of the servers you want to use
time:
string
Time increment for outage - 2h = 2 hours, 35m = 35 minutes, 1d = 1 day, 1h30m = 1 hour and 30 minutes. Max is 2 days. Default is in minutes if no time range specifier given (Required if using action: DISABLE )
user:
string
API Rest Account user ID
workID:
string
PDSM/CTASK for the request (Required if using action: DISABLE )
Example CURL Command: Be sure to change [user] and [pass] to your rest API login credentials.
The return message for request, whether fail or success.
"statusID":
int
The return code for request, 1 = SUCCESS, 2 = NOTHING FOUND, 5 > = APP ISSUE
Parameters
Parameter
Value
Description
action:
string
What action to perform - [QUERY|ENABLE|DISABLE]
pass:
string
The password for the user parameter.
serverName:
string
The name of the server you want to use
time:
string
Time increment for outage - 2h = 2 hours, 35m = 35 minutes, 1d = 1 day, 1h30m = 1 hour and 30 minutes. Max is 2 days. Default is in minutes if no time range specifier given (Required if using action: DISABLE )
user:
string
API Rest Account user ID
workID:
string
PDSM/CTASK for the request (Required if using action: DISABLE )
Example CURL Command: Be sure to change [user] and [pass] to your rest API login credentials.
Implementation Notes This REST API provides the ability to query a client for netbackup information.
Required fields: svrName
Response Information
"statusDesc":
string
Pure html output
"statusID":
int
1 = Results Found, 2 = Client not in Backuplist, 3 = Client not found, 4 = No server argument given, <4 = Error
Parameters
Parameter
Value
Description
backupMethod:
int
If given, the backup method wanted. For multiple values, seperate by comma. Values are: 1 = in-guest, 2 = snapshot. If no value is given, all methods are returned.
backupType:
int
If given, the backup type wanted. For multiple values, seperate by comma. Values are: 1 = Full Backup, 2 = Incremental, 3 = Restore. If no value is given, all backup types are returned.
limit:
int
If given, the number of results to return, based off the most recent date. If no value is given, all dates are returned. Use the value of 1 if you want ONLY the last item returned in the list( the most recent event, or method/type if defined ).
Implementation Notes This REST API provides the ability to query EAI information for a given server
Required fields: svrName
Response Information
"allresults":
string
Found matches,string will look like: EAI_NUMBER:EAI_NAME:IT_LEAD:IT_LEAD_LDAP_ID:IT_OWNER:IT_OWNER_LDAP_ID If multiple results, each grouping will be seperated by comma
"statusDesc":
string
Message returned to match the statusID value.
"statusID":
int
Response will either be [ 0 = Success, 3 = Not Found, 8 = Known Error, 9 = Unknown Error ]
Parameters
Parameter
Value
Description
eaiOnly:
string
Set to any value to only return EAI numbers, colon seperated
retired:
string
Set to any value to include records that are retired
Implementation Notes This REST API provides the ability to query,disable,enable, and remove a given server.
Required fields: svrName,acctID
Response Information
"statusDesc":
string
Message returned to match the statusID value.
"statusID":
int
Response will either be [ 0 = SUCCESS, 1 = FAIL ]
Parameters
Parameter
Value
Description
acctID:
string
MUST be an LDAP ID, which is used to RCS the changes.
action:
string
What action to perform, if blank, "query" is used. Values are: [query|disable|enable|remove]
comment:
string
Any information aboutt the removal that should be tracked. Should ONLY contain alpha, numeric, udnerscores, periods and backslash. Max length is 50 characters.
restPass:
string
The rest account password.
restUser:
string
The rest account username.
svrName:
string
The Server Name to work with.
Example CURL Command: Be sure to change [ldapuser] and [ldappass] to your login credentials if you use them.