gcloud scc custom-modules sha get-effective

NAME

gcloud scc custom-modules sha get-effective - get the details of a Security Health Analytics custom module with effective enablement state

SYNOPSIS

gcloud scc custom-modules sha get-effective CUSTOM_MODULE [--folder=FOLDER     | --organization=ORGANIZATION     | --project=PROJECT] [GCLOUD_WIDE_FLAG …]

DESCRIPTION

Get the details of a Security Health Analytics custom module. For inherited custom modules, the get-effective command resolves INHERITED enablement states to ENABLED or DISABLED. For example, if an inherited custom module is enabled at the ancestor level, then the get-effective command displays the enablement state as ENABLED instead of INHERITED in a child folder or project.

EXAMPLES

To get the details of a Security Health Analytics custom module 123456 with its effective enablement state from organization 123, run:

gcloud scc custom-modules sha get-effective 123456 --organization=organizations/123

To get the details of a Security Health Analytics custom module 123456 with its effective enablement state from folder 456, run:

gcloud scc custom-modules sha get-effective 123456 --folder=folders/456

To get the details of a Security Health Analytics custom module 123456 with its effective enablement state from project 789, run:

gcloud scc custom-modules sha get-effective 123456 --project=projects/789

POSITIONAL ARGUMENTS

CUSTOM_MODULE

ID or the full resource name of the effective Security Health Analytics custom module. If you specify the full resource name, you do not need to specify the --organization, --folder, or --project flags.

FLAGS

At most one of these can be specified:

--folder=FOLDER

Folder from which to get the custom module details. Formatted as folders/456 or just 456.

--organization=ORGANIZATION

Organization from which to get the custom module details. Formatted as organizations/123 or just 123.

--project=PROJECT

ID or number of the project from which to get the custom module details. Formatted as projects/789 or just 789.

GCLOUD WIDE FLAGS

These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, --help, --impersonate-service-account, --log-http, --project, --quiet, --trace-token, --user-output-enabled, --verbosity.

Run $ gcloud help for details.

API REFERENCE

This command uses the securitycenter/v1 API. The full documentation for this API can be found at: https://cloud.google.com/security-command-center

NOTES

This variant is also available:

gcloud alpha scc custom-modules sha get-effective