jssmemberlist (outputs a list of members)
- Organization of this page
Description
This command outputs a list of users (members) belonging to the 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 members to the CSV file up to that point.
Format
jssmemberlist -o member-list-file-name
[-roleid role-ID]
[-f]
Required execution permission
Administrator permissions
Storage folder
JP1/SS-path\bin\
Arguments
-o member-list-file-name
Use 255 bytes or less to specify the name of a member list file to which you want to output a list of members. 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 (-).
-roleid role-ID
Specifies the role ID of a user-created role or a system role if you want to output only a list of members of a specific role to the role member list file. You can use 1 to 64 half-width alphanumeric characters to specify the role ID of a user-created role.
-f
Overwrites the role member list file.
Return values
|
Return value |
Meaning |
|---|---|
|
0 |
Normal end |
|
1 |
Abnormal end |
Contents of a member list file
A member list file contains data in the following format.
![[Figure]](GRAPHICS/ZU110300.GIF)
The first line in the body section in a role member list file lists the names of attributes of the role members.
The details about the contents of a role member list file are as follows.
- Header section
-
Output sequence
Header item
Value
1
Product name
JP1/Service Support
2
Version number of the member list file
The version number of the file is indicated by 6 digits.
3
Character encoding
Character encoding of output files.
4
Type of data that is output to the member list file
MEMBERLIST
5
Number of role members that are output to the member list file
Total Count of Members : number-of-members
Output example: Total Count of Members : 2
- Body section
-
Output sequence
Body item
1
Role ID
2
User ID
3
User name
4
English name
5
Organization
6
Title
7
Title level
8
Email address
9
Phone number
10
Phone number 2
11
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 jssmemberlist command can be executed at a time.
Remarks
-
If you cancel the jssmemberlist command by using Ctrl+C while the command is being executed, a list of members 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.
-
One jssmemberlist command can output a maximum of 65,530 members to a member list file. If you want to output 65,531 or more role members, use the -roleid option to specify a role and execute the jssmemberlist command for the number of roles.
-
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 users that belong to a role with role ID Role1 to the member list file (c:\member\member01.csv).
jssmemberlist -o c:\member\member01.csv -roleid Role1