jssmemberdelete (deletes member information)
- Organization of this page
Description
This command deletes members from the roles that are registered in the JP1/IM - Service Support database.
Format
jssmemberdelete -i file-for-member-information-entries
[-f]
[-q]
Required execution permission
Administrator permissions
Storage folder
IM-SS-path\bin\
Arguments
-i file-for-member-information-entries
Use 255 bytes or less to specify the name for a file for member information entries. 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 (-). For details about role member entry files, see File for member information entries (Optional) in Chapter 12. Definition Files.
-f
Continues processing even if some of the data in the role member entry file is incorrect. When you specify the -f option, the command skips a role member in the role member entry file if the information about the member is incorrect and proceeds to delete the next member.
If you do not specify the -f option and the command fails to delete even a single role member in the role member entry file from a role, the command is canceled and the remaining members will not be deleted from roles.
-q
Deletes role members without displaying a confirmation message. If you do not specify the -q option, the system displays a message asking whether to permit deleting role members.
Return values
|
Return value |
Meaning |
|---|---|
|
0 |
Normal end |
|
1 |
Abnormal end |
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 11. Commands.
-
Only one jssmemberdelete command can be executed at a time. Also note that the jssmemberdelete command cannot be executed together with the jssmemberimport command.
Remarks
-
If you cancel the jssmemberdelete command while it is being executed, the remaining role members will not be deleted.
-
If you cancel the jssmemberdelete command by using Ctrl+C while the command is being executed, role members might not be deleted. 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 you specify an empty role member entry file, the command ends normally without deleting any role members.
-
A maximum of 2,000 lines can be entered in a role member entry file. Comment lines are not included in the number of lines. If you want to delete more than 2,000 role members, create multiple role member entry files and execute the command for those files.
-
If you enter the ID of a user that is not a member of a role in the role member entry file and execute the command, the command continues processing without displaying an error message or a warning message. The incorrect user in the role member entry file is not included in the number of deleted members.
-
Make sure that the input file you specify is created with a character encoding that is compatible with the system locale of the machine on which JP1/IM - Service Support is installed. The character encodings that can be used are as follows:
-
In a Japanese environment: MS932
-
In an English environment: ISO-8859-1
-
In a Chinese environment: GB18030
-
Example
The following example shows how to use the role member entry file (c:\member\member01.csv) to delete role members without displaying a confirmation message.
jssmemberdelete -i c:\member\member01.csv -q