AUTOSCALING_POLICY_CREATE(1)

NAME
autoscaling_policy_create -

•   Description

•   Usage

•   Required Parameters

•   Optional Parameters

•   Global Parameters

•   Examples

DESCRIPTION

Creates an autoscaling policy for the specified autoscaling configuration.

You can create the following types of autoscaling policies:

•   Schedule-based: Autoscaling events take place at the specific times that you schedule. - Threshold-based: An autoscaling action is triggered when a performance metric meets or exceeds a threshold.

    An autoscaling configuration can either have multiple schedule-based autoscaling policies, or one threshold-based autoscaling policy.

USAGE

oci autoscaling policy create [OPTIONS]

REQUIRED PARAMETERS

--auto-scaling-configuration-id [text]

    The OCID <https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm> of the autoscaling configuration.

--policy-type [text]

    The type of autoscaling policy.

OPTIONAL PARAMETERS

--capacity [complex type]

    The capacity requirements of the autoscaling policy. 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.

--display-name [text]

    A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

--execution-schedule [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.

--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

--is-enabled [boolean]

    Whether the autoscaling policy is enabled.

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 auto_scaling_configuration_id=<substitute-value-of-auto_scaling_configuration_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/autoscaling/policy/create.html#cmdoption-auto-scaling-configuration-id
    export policy_type=<substitute-value-of-policy_type> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/autoscaling/policy/create.html#cmdoption-policy-type
    oci autoscaling policy create --auto-scaling-configuration-id $auto_scaling_configuration_id --policy-type $policy_type

AUTHOR
Oracle

COPYRIGHT
2016, 2021, Oracle