manageEntityClassWhitelist command

Last Updated : Sep 24, 2021 |

With Release 8.1.3, you can add, list, view, and delete the subject names for the provided entity-class by using the manageEntityClassWhitelist command. You can add and delete the bulk entries of subject names for an entity class. Also, you can check the status of the subject name validation for the entity class.

Syntax

manageEntityClassWhitelist [-h] [addAll -e <ENTITY_CLASS_NAME> -f <INPUT_FILE> -u <USERNAME> -p <PASSWORD>] [add -e <ENTITY_CLASS_NAME> -s <SUBJECT_NAME> -u <USERNAME> -p <PASSWORD>] [list -e <ENTITY_CLASS_NAME> -f <OUTPUT_FILE> -u <USERNAME> -p <PASSWORD> -pn <PAGENUMBER> -ps <PAGESIZE>]  [view -e <ENTITY_CLASS_NAME> -s <SUBJECT_NAME> -f <OUTPUT_FILE> -u <USERNAME> -p <PASSWORD>] [subjectCheck -e <ENTITY_CLASS_NAME> -u <USERNAME> -p <PASSWORD>] [deleteAll -e <ENTITY_CLASS_NAME> -u <USERNAME> -p <PASSWORD>] [delete -e <ENTITY_CLASS_NAME> -s <SUBJECT_NAME> -u <USERNAME> -p <PASSWORD>]
-h
Displays help for the command and also displays the required and optional parameters.
addAll -e <ENTITY_CLASS_NAME> -f <INPUT_FILE> -u <USERNAME> -p <PASSWORD>
Adds or updates the Subject Names for the provided entity class through a file for bulk operation.
add -e <ENTITY_CLASS_NAME> -s <SUBJECT_NAME> -u <USERNAME> -p <PASSWORD>
Adds the Subject Names for the provided entity class.
list -e <ENTITY_CLASS_NAME> -f <OUTPUT_FILE> -u <USERNAME> -p <PASSWORD> -pn <PAGENUMBER> -ps <PAGESIZE>
Lists the Subject Names for the provided entity class. You can provide a file name where System Manager can save the Subject Names.
view -e <ENTITY_CLASS_NAME> -s <SUBJECT_NAME> -f <OUTPUT_FILE> -u <USERNAME> -p <PASSWORD>
Displays the Subject Name for the provided entity class. You can provide a file name where System Manager you can save all the Subject Names.
subjectCheck -e <ENTITY_CLASS_NAME> -u <USERNAME> -p <PASSWORD>
Displays the status of the subject name validation for the entity class. The status can be enabled or disabled.
deleteAll -e <ENTITY_CLASS_NAME> -u <USERNAME> -p <PASSWORD>
Deletes all the Subject Names for the provided entity class.
delete -e <ENTITY_CLASS_NAME> -s <SUBJECT_NAME> -u <USERNAME>-p <PASSWORD>
Deletes the specific entry of the Subject Name for the provided entity class.

Parameter

Description

<ENTITY_CLASS_NAME>

The name of the existing entity class that you create on the System Manager web console.

<SUBJECT_NAME>

The subject name for the entity class.

<INPUT_FILE>

The file name with the list of subject names and the file is available on the System Manager server. The file extension is .csv file.

Note:

The input file can have a maximum of 5000 whitelist entries in it. If you have more than 5000 whitelist entries to be added to the entityClass, add them in batches of 5000.

Following is an example of the format that is in the subject name file:

cat SubjectNameData.csv
subjectName
name1
name2
name3
name4
name5

<OUTPUT_FILE>

The file name where System Manager copies and saves the details of subject names for the entity class.

<USERNAMRE>

The user name of the System Manager web console for managing the entity classes.

<PASSWORD>

The password of the System Manager web console for managing the entity classes.

Note:

If you do not type the -u <USERNAME> and -p <PASSWORD> parameters with the command, System Manager displays the following options after pressing Enter:

Enter User Name : -----
Enter Password :-----

When the system prompts, provide the user name and password of the System Manager web console where the entity class is configured.

<PAGENUMBER>

Displays the list of subject name for the provided entity class on the specific page number.

<PAGESIZE>

Displays the total number of subject names for the provided entity class.
Related information
Viewing the subject name validation status for an entity class
Adding subject names for an entity class