.\" Man page generated from reStructuredText.
.
.TH "ANNOUNCE_ANNOUNCEMENTS" "1" "Jun 17, 2024" "3.43.2" "OCI CLI Command Reference"
.SH NAME
announce_announcements \- 
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH DESCRIPTION
.sp
An announcement represents a message targetted to a specific tenant.
.SH AVAILABLE COMMANDS
.INDENT 0.0
.IP \(bu 2
get
.IP \(bu 2
list
.UNINDENT
.SS \fBget\fP
.INDENT 0.0
.IP \(bu 2
\fI\%Description\fP
.IP \(bu 2
\fI\%Usage\fP
.IP \(bu 2
\fI\%Required Parameters\fP
.IP \(bu 2
\fI\%Optional Parameters\fP
.IP \(bu 2
\fI\%Global Parameters\fP
.IP \(bu 2
\fI\%Example using required parameter\fP
.UNINDENT
.SS Description
.sp
Gets the details of a specific announcement.
.sp
This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.
.SS Usage
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
oci announce announcements get [OPTIONS]
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Required Parameters
.INDENT 0.0
.TP
.B \-\-announcement\-id [text]
.UNINDENT
.sp
The OCID of the announcement.
.SS Optional Parameters
.INDENT 0.0
.TP
.B \-\-from\-json [text]
.UNINDENT
.sp
Provide input to this command as a JSON document from a file using the \fI\%file://path\-to/file\fP syntax.
.sp
The \fB\-\-generate\-full\-command\-json\-input\fP 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.
.sp
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.
.sp
For examples on usage of this option, please see our “using CLI with advanced JSON options” link: \fI\%https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/cliusing.htm#AdvancedJSONOptions\fP
.SS Global Parameters
.sp
Use \fBoci \-\-help\fP for help on global parameters.
.sp
\fB\-\-auth\-purpose\fP, \fB\-\-auth\fP, \fB\-\-cert\-bundle\fP, \fB\-\-cli\-auto\-prompt\fP, \fB\-\-cli\-rc\-file\fP, \fB\-\-config\-file\fP, \fB\-\-connection\-timeout\fP, \fB\-\-debug\fP, \fB\-\-defaults\-file\fP, \fB\-\-endpoint\fP, \fB\-\-generate\-full\-command\-json\-input\fP, \fB\-\-generate\-param\-json\-input\fP, \fB\-\-help\fP, \fB\-\-latest\-version\fP, \fB\-\-max\-retries\fP, \fB\-\-no\-retry\fP, \fB\-\-opc\-client\-request\-id\fP, \fB\-\-opc\-request\-id\fP, \fB\-\-output\fP, \fB\-\-profile\fP, \fB\-\-proxy\fP, \fB\-\-query\fP, \fB\-\-raw\-output\fP, \fB\-\-read\-timeout\fP, \fB\-\-realm\-specific\-endpoint\fP, \fB\-\-region\fP, \fB\-\-release\-info\fP, \fB\-\-request\-id\fP, \fB\-\-version\fP, \fB\-?\fP, \fB\-d\fP, \fB\-h\fP, \fB\-i\fP, \fB\-v\fP
.SS Example using required parameter
.sp
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.
.sp
Please note this sample will only work in the POSIX\-compliant bash\-like shell. You need to set up \fI\%the OCI configuration\fP <\fBhttps://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/cliinstall.htm#configfile\fP> and \fI\%appropriate security policies\fP <\fBhttps://docs.oracle.com/en-us/iaas/Content/Identity/Concepts/policygetstarted.htm\fP> before trying the examples.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
    export announcement_id=<substitute\-value\-of\-announcement_id> # https://docs.cloud.oracle.com/en\-us/iaas/tools/oci\-cli/latest/oci_cli_docs/cmdref/announce/announcements/get.html#cmdoption\-announcement\-id

    oci announce announcements get \-\-announcement\-id $announcement_id
.ft P
.fi
.UNINDENT
.UNINDENT
.SS \fBlist\fP
.INDENT 0.0
.IP \(bu 2
\fI\%Description\fP
.IP \(bu 2
\fI\%Usage\fP
.IP \(bu 2
\fI\%Required Parameters\fP
.IP \(bu 2
\fI\%Optional Parameters\fP
.IP \(bu 2
\fI\%Global Parameters\fP
.IP \(bu 2
\fI\%Example using required parameter\fP
.UNINDENT
.SS Description
.sp
Gets a list of announcements for the current tenancy.
.sp
This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.
.SS Usage
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
oci announce announcements list [OPTIONS]
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Required Parameters
.INDENT 0.0
.TP
.B \-\-compartment\-id, \-c [text]
.UNINDENT
.sp
The OCID of the compartment.
.SS Optional Parameters
.INDENT 0.0
.TP
.B \-\-all
.UNINDENT
.sp
Fetches all pages of results. If you provide this option, then you cannot provide the \fB\-\-limit\fP option.
.INDENT 0.0
.TP
.B \-\-announcement\-type [text]
.UNINDENT
.sp
The type of announcement.
.INDENT 0.0
.TP
.B \-\-chain\-id [text]
.UNINDENT
.sp
A filter to return only announcements belonging to the specified announcement chain ID.
.INDENT 0.0
.TP
.B \-\-environment\-name [text]
.UNINDENT
.sp
A filter to return only announcements that match a specific environment name.
.INDENT 0.0
.TP
.B \-\-exclude\-announcement\-types [text]
.UNINDENT
.sp
Exclude The type of announcement.
.INDENT 0.0
.TP
.B \-\-from\-json [text]
.UNINDENT
.sp
Provide input to this command as a JSON document from a file using the \fI\%file://path\-to/file\fP syntax.
.sp
The \fB\-\-generate\-full\-command\-json\-input\fP 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.
.sp
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.
.sp
For examples on usage of this option, please see our “using CLI with advanced JSON options” link: \fI\%https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/cliusing.htm#AdvancedJSONOptions\fP
.INDENT 0.0
.TP
.B \-\-is\-banner [boolean]
.UNINDENT
.sp
Whether the announcement is displayed as a console banner.
.INDENT 0.0
.TP
.B \-\-lifecycle\-state [text]
.UNINDENT
.sp
The announcement’s current lifecycle state.
.sp
Accepted values are:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ACTIVE, INACTIVE
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B \-\-limit [integer]
.UNINDENT
.sp
The maximum number of items to return in a paginated “List” call.
.INDENT 0.0
.TP
.B \-\-page [text]
.UNINDENT
.sp
The value of the \fIopc\-next\-page\fP response header from the previous “List” call.
.INDENT 0.0
.TP
.B \-\-page\-size [integer]
.UNINDENT
.sp
When fetching results, the number of results to fetch per call. Only valid when used with \fB\-\-all\fP or \fB\-\-limit\fP, and ignored otherwise.
.INDENT 0.0
.TP
.B \-\-platform\-type [text]
.UNINDENT
.sp
A filter to return only announcements affecting a specific platform.
.sp
Accepted values are:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
IAAS, SAAS
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B \-\-service [text]
.UNINDENT
.sp
A filter to return only announcements affecting a specific service.
.INDENT 0.0
.TP
.B \-\-should\-show\-only\-latest\-in\-chain [boolean]
.UNINDENT
.sp
A filter to display only the latest announcement in a chain.
.INDENT 0.0
.TP
.B \-\-sort\-by [text]
.UNINDENT
.sp
The criteria to sort by. You can specify only one sort order.
.sp
Accepted values are:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
announcementType, referenceTicketNumber, summary, timeCreated, timeOneValue, timeTwoValue
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B \-\-sort\-order [text]
.UNINDENT
.sp
The sort order to use. (Sorting by \fIannouncementType\fP orders the announcements list according to importance.)
.sp
Accepted values are:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ASC, DESC
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B \-\-time\-one\-earliest\-time [datetime]
.UNINDENT
.sp
The boundary for the earliest \fItimeOneValue\fP date on announcements that you want to see.
.INDENT 0.0
.INDENT 3.5
The following datetime formats are supported:
.UNINDENT
.UNINDENT
.SS UTC with microseconds
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Format: YYYY\-MM\-DDTHH:mm:ss.ssssssTZD
Example: 2017\-09\-15T20:30:00.123456Z

UTC with milliseconds
***********************
\&.. code::

    Format: YYYY\-MM\-DDTHH:mm:ss.sssTZD
    Example: 2017\-09\-15T20:30:00.123Z

UTC without milliseconds
**************************
\&.. code::

    Format: YYYY\-MM\-DDTHH:mm:ssTZD
    Example: 2017\-09\-15T20:30:00Z

UTC with minute precision
**************************
\&.. code::

    Format: YYYY\-MM\-DDTHH:mmTZD
    Example: 2017\-09\-15T20:30Z
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Timezone with microseconds
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Format: YYYY\-MM\-DDTHH:mm:ssTZD
Example: 2017\-09\-15T12:30:00.456789\-08:00, 2017\-09\-15T12:30:00.456789\-0800

Timezone with milliseconds
***************************
\&.. code::

    Format: YYYY\-MM\-DDTHH:mm:ssTZD
    Example: 2017\-09\-15T12:30:00.456\-08:00, 2017\-09\-15T12:30:00.456\-0800

Timezone without milliseconds
*******************************
\&.. code::

    Format: YYYY\-MM\-DDTHH:mm:ssTZD
    Example: 2017\-09\-15T12:30:00\-08:00, 2017\-09\-15T12:30:00\-0800

Timezone with minute precision
*******************************
\&.. code::

    Format: YYYY\-MM\-DDTHH:mmTZD
    Example: 2017\-09\-15T12:30\-08:00, 2017\-09\-15T12:30\-0800

Short date and time
********************
The timezone for this date and time will be taken as UTC (Needs to be surrounded by single or double quotes)

\&.. code::

    Format: \(aqYYYY\-MM\-DD HH:mm\(aq or "YYYY\-MM\-DD HH:mm"
    Example: \(aq2017\-09\-15 17:25\(aq

Date Only
**********
This date will be taken as midnight UTC of that day

\&.. code::

    Format: YYYY\-MM\-DD
    Example: 2017\-09\-15

Epoch seconds
**************
\&.. code::

    Example: 1412195400
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B \-\-time\-one\-latest\-time [datetime]
.UNINDENT
.sp
The boundary for the latest \fItimeOneValue\fP date on announcements that you want to see.
.INDENT 0.0
.INDENT 3.5
The following datetime formats are supported:
.UNINDENT
.UNINDENT
.SS UTC with microseconds
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Format: YYYY\-MM\-DDTHH:mm:ss.ssssssTZD
Example: 2017\-09\-15T20:30:00.123456Z

UTC with milliseconds
***********************
\&.. code::

    Format: YYYY\-MM\-DDTHH:mm:ss.sssTZD
    Example: 2017\-09\-15T20:30:00.123Z

UTC without milliseconds
**************************
\&.. code::

    Format: YYYY\-MM\-DDTHH:mm:ssTZD
    Example: 2017\-09\-15T20:30:00Z

UTC with minute precision
**************************
\&.. code::

    Format: YYYY\-MM\-DDTHH:mmTZD
    Example: 2017\-09\-15T20:30Z
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Timezone with microseconds
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Format: YYYY\-MM\-DDTHH:mm:ssTZD
Example: 2017\-09\-15T12:30:00.456789\-08:00, 2017\-09\-15T12:30:00.456789\-0800

Timezone with milliseconds
***************************
\&.. code::

    Format: YYYY\-MM\-DDTHH:mm:ssTZD
    Example: 2017\-09\-15T12:30:00.456\-08:00, 2017\-09\-15T12:30:00.456\-0800

Timezone without milliseconds
*******************************
\&.. code::

    Format: YYYY\-MM\-DDTHH:mm:ssTZD
    Example: 2017\-09\-15T12:30:00\-08:00, 2017\-09\-15T12:30:00\-0800

Timezone with minute precision
*******************************
\&.. code::

    Format: YYYY\-MM\-DDTHH:mmTZD
    Example: 2017\-09\-15T12:30\-08:00, 2017\-09\-15T12:30\-0800

Short date and time
********************
The timezone for this date and time will be taken as UTC (Needs to be surrounded by single or double quotes)

\&.. code::

    Format: \(aqYYYY\-MM\-DD HH:mm\(aq or "YYYY\-MM\-DD HH:mm"
    Example: \(aq2017\-09\-15 17:25\(aq

Date Only
**********
This date will be taken as midnight UTC of that day

\&.. code::

    Format: YYYY\-MM\-DD
    Example: 2017\-09\-15

Epoch seconds
**************
\&.. code::

    Example: 1412195400
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Global Parameters
.sp
Use \fBoci \-\-help\fP for help on global parameters.
.sp
\fB\-\-auth\-purpose\fP, \fB\-\-auth\fP, \fB\-\-cert\-bundle\fP, \fB\-\-cli\-auto\-prompt\fP, \fB\-\-cli\-rc\-file\fP, \fB\-\-config\-file\fP, \fB\-\-connection\-timeout\fP, \fB\-\-debug\fP, \fB\-\-defaults\-file\fP, \fB\-\-endpoint\fP, \fB\-\-generate\-full\-command\-json\-input\fP, \fB\-\-generate\-param\-json\-input\fP, \fB\-\-help\fP, \fB\-\-latest\-version\fP, \fB\-\-max\-retries\fP, \fB\-\-no\-retry\fP, \fB\-\-opc\-client\-request\-id\fP, \fB\-\-opc\-request\-id\fP, \fB\-\-output\fP, \fB\-\-profile\fP, \fB\-\-proxy\fP, \fB\-\-query\fP, \fB\-\-raw\-output\fP, \fB\-\-read\-timeout\fP, \fB\-\-realm\-specific\-endpoint\fP, \fB\-\-region\fP, \fB\-\-release\-info\fP, \fB\-\-request\-id\fP, \fB\-\-version\fP, \fB\-?\fP, \fB\-d\fP, \fB\-h\fP, \fB\-i\fP, \fB\-v\fP
.SS Example using required parameter
.sp
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.
.sp
Please note this sample will only work in the POSIX\-compliant bash\-like shell. You need to set up \fI\%the OCI configuration\fP <\fBhttps://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/cliinstall.htm#configfile\fP> and \fI\%appropriate security policies\fP <\fBhttps://docs.oracle.com/en-us/iaas/Content/Identity/Concepts/policygetstarted.htm\fP> before trying the examples.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
    export compartment_id=<substitute\-value\-of\-compartment_id> # https://docs.cloud.oracle.com/en\-us/iaas/tools/oci\-cli/latest/oci_cli_docs/cmdref/announce/announcements/list.html#cmdoption\-compartment\-id

    oci announce announcements list \-\-compartment\-id $compartment_id
.ft P
.fi
.UNINDENT
.UNINDENT
.SH AUTHOR
Oracle
.SH COPYRIGHT
2016, 2024, Oracle
.\" Generated by docutils manpage writer.
.
