Custom Fault Entity Interface

Prototype

ascend-fd entity <Subcommand>

Function

Provides functions related to custom fault entities, including adding, modifying, querying, or deleting custom fault entities, and validating the custom fault entity file custom-ascend-kg-config.json.

Parameters

Table 1 Subcommand parameters

ParameterAbbreviationRequiredValue TypeDescription
--update-uRequired. --update, --delete, --show, and --check are mutually exclusive, meaning only one can and must be specified.StringAdds or modifies custom fault entity information in JSON file format. For details about the parameters in the JSON file, see Table 1 Parameters.
--delete-dRequired. --update, --delete, --show, and --check are mutually exclusive, meaning only one can and must be specified.StringDeletes the custom fault entity information corresponding to the specified fault codes. Separate multiple fault codes with spaces.
--show-sRequired. --update, --delete, --show, and --check are mutually exclusive, meaning only one can and must be specified.StringViews custom fault entity information by fault code, with multiple fault codes separated by spaces. If no fault code is specified, all custom fault entity information is queried.
--check-cRequired. --update, --delete, --show, and --check are mutually exclusive, meaning only one can and must be specified.StringChecks the validity of the custom-ascend-kg-config.json file, primarily verifying the validity of the field attributes of each custom fault entity.
--itemNoneOptionalStringViews partial information of a custom fault entity. Separate multiple values with spaces. If no value is specified, the information of the following three values is displayed.
  • attribute: attribute information
  • rule: fault chain
  • regex: fault keyword

Must be used with the --show (or -s) parameter.

--force-fOptionalBoolWhen this parameter is specified to delete a custom fault entity, no confirmation prompt will appear on the interface.

Must be used with the --delete (or -d) parameter.

--help-hOptional-Queries usage instructions.

Returns

Example: Add a custom fault entity through a JSON file.

ascend-fd entity -u test_base.json
Updated entity successfully.