CLOUD-GUARD_TARGET-RESPONDER-RECIPE-RESPONDER-RULE(1)

NAME
cloud-guard_target-responder-recipe-responder-rule -

DESCRIPTION

Details of ResponderRule.

AVAILABLE COMMANDS

•   get

•   list

•   update

  get

•   Description

•   Usage

•   Required Parameters

•   Optional Parameters

•   Global Parameters

•   Examples

  Description

Get ResponderRule by identifier

  Usage

oci cloud-guard target-responder-recipe-responder-rule get [OPTIONS]

  Required Parameters

--responder-rule-id [text]

    The id of ResponderRule

--target-id [text]

    OCID of target

--target-responder-recipe-id [text]

    OCID of TargetResponderRecipe

  Optional Parameters

--from-json [text]

    Provide input to this command as a JSON document from a file using the file://path-to/file syntax.

    The --generate-full-command-json-input option can be used to generate a sample json file to be used with this command option. The key names are pre-populated and match the command option names (converted to camelCase format, e.g. compartment-id –> compartmentId), while the values of the keys need to be populated by the user before using the sample file as an input to this command. For any command option that accepts multiple values, the value of the key can be a JSON array.

    Options can still be provided on the command line. If an option exists in both the JSON document and the command line then the command line specified value will be used.

    For examples on usage of this option, please see our “using CLI with advanced JSON options” link: https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/cliusing.htm#AdvancedJSONOptions

  Global Parameters

Use oci --help for help on global parameters.

--auth-purpose, --auth, --cert-bundle, --cli-rc-file, --config-file, --debug, --defaults-file, --endpoint, --generate-full-command-json-input, --generate-param-json-input, --help, --latest-version, --max-retries, --no-retry, --opc-client-request-id, --opc-request-id, --output, --profile, --query, --raw-output, --region, --release-info, --request-id, --version, -?, -d, -h, -v

  Examples

Copy the following CLI commands into a file named example.sh. Run the command by typing “bash example.sh” and replacing the example parameters with your own.

Please note this sample will only work in the POSIX-compliant bash-like shell. You need to set up the OCI configuration <https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/cliinstall.htm#configfile> and appropriate security policies <https://docs.oracle.com/en-us/iaas/Content/Identity/Concepts/policygetstarted.htm> before trying the examples.

    export compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/cloud-guard/responder-recipe/create.html#cmdoption-compartment-id
    export display_name=<substitute-value-of-display_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/cloud-guard/responder-recipe/create.html#cmdoption-display-name
    export target_resource_id=<substitute-value-of-target_resource_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/cloud-guard/target/create.html#cmdoption-target-resource-id
    export target_resource_type=<substitute-value-of-target_resource_type> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/cloud-guard/target/create.html#cmdoption-target-resource-type
    export source_responder_recipe_id=<substitute-value-of-source_responder_recipe_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/cloud-guard/responder-recipe/create.html#cmdoption-source-responder-recipe-id
    export target_id=<substitute-value-of-target_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/cloud-guard/target-responder-recipe/create.html#cmdoption-target-id
    export responder_rule_id=<substitute-value-of-responder_rule_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/cloud-guard/target-responder-recipe-responder-rule/get.html#cmdoption-responder-rule-id
    target_id=$(oci cloud-guard target create --compartment-id $compartment_id --display-name $display_name --target-resource-id $target_resource_id --target-resource-type $target_resource_type --query data.id --raw-output)
    responder_recipe_id=$(oci cloud-guard responder-recipe create --compartment-id $compartment_id --display-name $display_name --source-responder-recipe-id $source_responder_recipe_id --query data.id --raw-output)
    target_responder_recipe_id=$(oci cloud-guard target-responder-recipe create --responder-recipe-id $responder_recipe_id --target-id $target_id --query data.id --raw-output)
    oci cloud-guard target-responder-recipe-responder-rule get --responder-rule-id $responder_rule_id --target-id $target_id --target-responder-recipe-id $target_responder_recipe_id

  list

•   Description

•   Usage

•   Required Parameters

•   Optional Parameters

•   Global Parameters

•   Examples

  Description

Returns a list of ResponderRule associated with ResponderRecipe within a Target.

  Usage

oci cloud-guard target-responder-recipe-responder-rule list [OPTIONS]

  Required Parameters

--compartment-id, -c [text]

    The ID of the compartment in which to list resources.

--target-id [text]

    OCID of target

--target-responder-recipe-id [text]

    OCID of TargetResponderRecipe

  Optional Parameters

--all

    Fetches all pages of results. If you provide this option, then you cannot provide the --limit option.

--display-name [text]

    A filter to return only resources that match the entire display name given.

--from-json [text]

    Provide input to this command as a JSON document from a file using the file://path-to/file syntax.

    The --generate-full-command-json-input option can be used to generate a sample json file to be used with this command option. The key names are pre-populated and match the command option names (converted to camelCase format, e.g. compartment-id –> compartmentId), while the values of the keys need to be populated by the user before using the sample file as an input to this command. For any command option that accepts multiple values, the value of the key can be a JSON array.

    Options can still be provided on the command line. If an option exists in both the JSON document and the command line then the command line specified value will be used.

    For examples on usage of this option, please see our “using CLI with advanced JSON options” link: https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/cliusing.htm#AdvancedJSONOptions

--lifecycle-state [text]

    The field life cycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.

    Accepted values are:

    ACTIVE, CREATING, DELETED, DELETING, FAILED, INACTIVE, UPDATING

--limit [integer]

    The maximum number of items to return.

--page [text]

    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

--page-size [integer]

    When fetching results, the number of results to fetch per call. Only valid when used with --all or --limit, and ignored otherwise.

--sort-by [text]

    The field to sort by. Only one sort order may be provided. Default order for displayName is ascending. If no value is specified displayName is default.

    Accepted values are:

    displayName, riskLevel

--sort-order [text]

    The sort order to use, either ‘asc’ or ‘desc’.

    Accepted values are:

    ASC, DESC

  Global Parameters

Use oci --help for help on global parameters.

--auth-purpose, --auth, --cert-bundle, --cli-rc-file, --config-file, --debug, --defaults-file, --endpoint, --generate-full-command-json-input, --generate-param-json-input, --help, --latest-version, --max-retries, --no-retry, --opc-client-request-id, --opc-request-id, --output, --profile, --query, --raw-output, --region, --release-info, --request-id, --version, -?, -d, -h, -v

  Examples

Copy the following CLI commands into a file named example.sh. Run the command by typing “bash example.sh” and replacing the example parameters with your own.

Please note this sample will only work in the POSIX-compliant bash-like shell. You need to set up the OCI configuration <https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/cliinstall.htm#configfile> and appropriate security policies <https://docs.oracle.com/en-us/iaas/Content/Identity/Concepts/policygetstarted.htm> before trying the examples.

    export compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/cloud-guard/responder-recipe/create.html#cmdoption-compartment-id
    export display_name=<substitute-value-of-display_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/cloud-guard/responder-recipe/create.html#cmdoption-display-name
    export target_resource_id=<substitute-value-of-target_resource_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/cloud-guard/target/create.html#cmdoption-target-resource-id
    export target_resource_type=<substitute-value-of-target_resource_type> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/cloud-guard/target/create.html#cmdoption-target-resource-type
    export source_responder_recipe_id=<substitute-value-of-source_responder_recipe_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/cloud-guard/responder-recipe/create.html#cmdoption-source-responder-recipe-id
    export target_id=<substitute-value-of-target_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/cloud-guard/target-responder-recipe/create.html#cmdoption-target-id
    target_id=$(oci cloud-guard target create --compartment-id $compartment_id --display-name $display_name --target-resource-id $target_resource_id --target-resource-type $target_resource_type --query data.id --raw-output)
    responder_recipe_id=$(oci cloud-guard responder-recipe create --compartment-id $compartment_id --display-name $display_name --source-responder-recipe-id $source_responder_recipe_id --query data.id --raw-output)
    target_responder_recipe_id=$(oci cloud-guard target-responder-recipe create --responder-recipe-id $responder_recipe_id --target-id $target_id --query data.id --raw-output)
    oci cloud-guard target-responder-recipe-responder-rule list --compartment-id $compartment_id --target-id $target_id --target-responder-recipe-id $target_responder_recipe_id

  update

•   Description

•   Usage

•   Required Parameters

•   Optional Parameters

•   Global Parameters

•   Examples

  Description

Update the ResponderRule by identifier

  Usage

oci cloud-guard target-responder-recipe-responder-rule update [OPTIONS]

  Required Parameters

--details [complex type]

    This is a complex type whose value must be valid JSON. The value can be provided as a string on the command line or passed in as a file using the file://path/to/file syntax.

    The --generate-param-json-input option can be used to generate an example of the JSON which must be provided. We recommend storing this example in a file, modifying it as needed and then passing it back in via the file:// syntax.

--responder-rule-id [text]

    The id of ResponderRule

--target-id [text]

    OCID of target

--target-responder-recipe-id [text]

    OCID of TargetResponderRecipe

  Optional Parameters

--force

    Perform update without prompting for confirmation.

--from-json [text]

    Provide input to this command as a JSON document from a file using the file://path-to/file syntax.

    The --generate-full-command-json-input option can be used to generate a sample json file to be used with this command option. The key names are pre-populated and match the command option names (converted to camelCase format, e.g. compartment-id –> compartmentId), while the values of the keys need to be populated by the user before using the sample file as an input to this command. For any command option that accepts multiple values, the value of the key can be a JSON array.

    Options can still be provided on the command line. If an option exists in both the JSON document and the command line then the command line specified value will be used.

    For examples on usage of this option, please see our “using CLI with advanced JSON options” link: https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/cliusing.htm#AdvancedJSONOptions

--if-match [text]

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.

--max-wait-seconds [integer]

    The maximum time to wait for the resource to reach the lifecycle state defined by --wait-for-state. Defaults to 1200 seconds.

--wait-for-state [text]

    This operation creates, modifies or deletes a resource that has a defined lifecycle state. Specify this option to perform the action and then wait until the resource reaches a given lifecycle state. Multiple states can be specified, returning on the first state. For example, --wait-for-state SUCCEEDED --wait-for-state FAILED would return on whichever lifecycle state is reached first. If timeout is reached, a return code of 2 is returned. For any other error, a return code of 1 is returned.

    Accepted values are:

    ACTIVE, CREATING, DELETED, DELETING, FAILED, INACTIVE, UPDATING

--wait-interval-seconds [integer]

    Check every --wait-interval-seconds to see whether the resource to see if it has reached the lifecycle state defined by --wait-for-state. Defaults to 30 seconds.

  Global Parameters

Use oci --help for help on global parameters.

--auth-purpose, --auth, --cert-bundle, --cli-rc-file, --config-file, --debug, --defaults-file, --endpoint, --generate-full-command-json-input, --generate-param-json-input, --help, --latest-version, --max-retries, --no-retry, --opc-client-request-id, --opc-request-id, --output, --profile, --query, --raw-output, --region, --release-info, --request-id, --version, -?, -d, -h, -v

  Examples

Copy and paste the following example into a JSON file, replacing the example parameters with your own.

    oci cloud-guard target-responder-recipe-responder-rule update --generate-param-json-input details > details.json

Copy the following CLI commands into a file named example.sh. Run the command by typing “bash example.sh” and replacing the example parameters with your own.

Please note this sample will only work in the POSIX-compliant bash-like shell. You need to set up the OCI configuration <https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/cliinstall.htm#configfile> and appropriate security policies <https://docs.oracle.com/en-us/iaas/Content/Identity/Concepts/policygetstarted.htm> before trying the examples.

    export compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/cloud-guard/responder-recipe/create.html#cmdoption-compartment-id
    export display_name=<substitute-value-of-display_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/cloud-guard/responder-recipe/create.html#cmdoption-display-name
    export target_resource_id=<substitute-value-of-target_resource_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/cloud-guard/target/create.html#cmdoption-target-resource-id
    export target_resource_type=<substitute-value-of-target_resource_type> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/cloud-guard/target/create.html#cmdoption-target-resource-type
    export source_responder_recipe_id=<substitute-value-of-source_responder_recipe_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/cloud-guard/responder-recipe/create.html#cmdoption-source-responder-recipe-id
    export target_id=<substitute-value-of-target_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/cloud-guard/target-responder-recipe/create.html#cmdoption-target-id
    export responder_rule_id=<substitute-value-of-responder_rule_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/cloud-guard/target-responder-recipe-responder-rule/update.html#cmdoption-responder-rule-id
    target_id=$(oci cloud-guard target create --compartment-id $compartment_id --display-name $display_name --target-resource-id $target_resource_id --target-resource-type $target_resource_type --query data.id --raw-output)
    responder_recipe_id=$(oci cloud-guard responder-recipe create --compartment-id $compartment_id --display-name $display_name --source-responder-recipe-id $source_responder_recipe_id --query data.id --raw-output)
    target_responder_recipe_id=$(oci cloud-guard target-responder-recipe create --responder-recipe-id $responder_recipe_id --target-id $target_id --query data.id --raw-output)
    oci cloud-guard target-responder-recipe-responder-rule update --details file://details.json --responder-rule-id $responder_rule_id --target-id $target_id --target-responder-recipe-id $target_responder_recipe_id

AUTHOR
Oracle

COPYRIGHT
2016, 2021, Oracle