jssrolelist (outputs a list of roles)
- Organization of this page
Description
This command outputs a list of roles that are registered in the JP1/Service Support database to a CSV file. If you cancel the command while it is being executed, the command outputs a list of roles up to that point.
Format
jssrolelist -o role-list-file-name
[-f]
Required execution permission
Administrator permissions
Storage folder
JP1/SS-path\bin\
Arguments
-o role-list-file-name
Use 255 bytes or less to specify the name of a role list file in CSV format to which you want to output a list of roles. Count two bytes for full-width characters in the file name. You can use an absolute path or a relative path to specify the file name. When you use a relative path, make sure that it will be 255 bytes or less after it is converted to an absolute path. For the file name, you cannot specify a character string beginning with a hyphen (-).
-f
Overwrites the role list file.
Return values
|
Return value |
Meaning |
|---|---|
|
0 |
Normal end |
|
1 |
Abnormal end |
Contents of a role list file
A role list file contains data in the following format.
![[Figure]](GRAPHICS/ZU110400.GIF)
The first line in the body section in a role list file lists the names of the roles' attributes.
The details about the contents of a role list file are as follows.
- Header section
-
Output sequence
Header item
Value
1
Product name
JP1/Service Support
2
Version number of the role list file
The version number of the file is indicated by 6 digits.
3
Character encoding used in the role list file
Character encoding of output files.
4
Type of data that is output to the role list file
ROLELIST
5
Number of roles that are output to the role list file
Total Count of Roles : number-of-roles
Output example: Total Count of Roles : 3
- Body section
-
Output sequence
Body item
1
Role ID
2
Role name
3
Comment
Prerequisites for executing the command
-
For details about which services need to be active or inactive when this command is executed, see Status of services when commands are executed in Chapter 12. Commands.
-
Only one jssrolelist command can be executed at a time.
Remarks
-
If you cancel the jssrolelist command by using Ctrl+C while the command is being executed, a list of roles might not be output. For this reason, do not cancel the command during execution by using Ctrl+C. If you happen to do so, wait for a while and then re-execute the command.
-
If the information to be output includes characters that are mapped with UTF-8 but that are not mapped with the character set used in the operating environment, those characters are replaced with question marks (?) in the CSV file output.
Example
The following example shows how to output a list of roles to the role list file (c:\role\role01.csv). The role list file is overwritten.
jssrolelist -o c:\role\role01.csv -f