``export-csv``
==============
.. contents:: :local:
 :depth: 1
Description
------------
Exports a list of HostAgentScanResultSummary objects within a compartment and during a specified time range in CSV format. You can filter the results by problem severity. 


Usage
-----
.. code-block:: none

  oci vulnerability-scanning host scan result agent export-csv [OPTIONS]

Required Parameters
--------------------
.. option:: --compartment-id, -c [text]

The `OCID <https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm>`__ of the compartment to list scans in.

.. option:: --file [filename]

The name of the file that will receive the response data, or '-' to write to STDOUT.

.. option:: --time-started-after [datetime]

Date and time after which scans were started, as described in `RFC 3339 <https://tools.ietf.org/rfc/rfc3339>`__

    The following datetime formats are supported:

UTC with microseconds
***********************
.. code::

    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

Timezone with microseconds
***************************
.. code::

    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: 'YYYY-MM-DD HH:mm' or "YYYY-MM-DD HH:mm"
        Example: '2017-09-15 17:25'

    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
   

.. option:: --time-started-before [datetime]

Date and time before which scans were started, as described in `RFC 3339 <https://tools.ietf.org/rfc/rfc3339>`__

    The following datetime formats are supported:

UTC with microseconds
***********************
.. code::

    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

Timezone with microseconds
***************************
.. code::

    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: 'YYYY-MM-DD HH:mm' or "YYYY-MM-DD HH:mm"
        Example: '2017-09-15 17:25'

    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
   


Optional Parameters
--------------------
.. option:: --from-json [text]

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

The :option:`--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

.. option:: --highest-problem-severity [text]

Parameter to filter by highestProblemSeverity for scan results

Accepted values are:

.. code-block:: py

    CRITICAL, HIGH, LOW, MEDIUM, NONE

.. option:: --instance-id [text]

Parameter to filter by a single compute instance ID for scan results

.. option:: --operating-system [text]

Parameter to filter by operating system for scan results



Global Parameters
------------------
Use ``oci --help`` for help on global parameters.

:option:`--auth-purpose`, :option:`--auth`, :option:`--cert-bundle`, :option:`--cli-auto-prompt`, :option:`--cli-rc-file`, :option:`--config-file`, :option:`--connection-timeout`, :option:`--debug`, :option:`--defaults-file`, :option:`--endpoint`, :option:`--generate-full-command-json-input`, :option:`--generate-param-json-input`, :option:`--help`, :option:`--latest-version`, :option:`--max-retries`, :option:`--no-retry`, :option:`--opc-client-request-id`, :option:`--opc-request-id`, :option:`--output`, :option:`--profile`, :option:`--proxy`, :option:`--query`, :option:`--raw-output`, :option:`--read-timeout`, :option:`--realm-specific-endpoint`, :option:`--region`, :option:`--release-info`, :option:`--request-id`, :option:`--version`, :option:`-?`, :option:`-d`, :option:`-h`, :option:`-i`, :option:`-v`



Example using required parameter
------------------

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.

.. code-block:: none
    :class: copy-code-block

    
	export compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/vulnerability-scanning/host/scan/result/agent/export-csv.html#cmdoption-compartment-id
	export file=<substitute-value-of-file> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/vulnerability-scanning/host/scan/result/agent/export-csv.html#cmdoption-file
	export time_started_after=<substitute-value-of-time_started_after> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/vulnerability-scanning/host/scan/result/agent/export-csv.html#cmdoption-time-started-after
	export time_started_before=<substitute-value-of-time_started_before> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/vulnerability-scanning/host/scan/result/agent/export-csv.html#cmdoption-time-started-before
	
	oci vulnerability-scanning host scan result agent export-csv --compartment-id $compartment_id --file $file --time-started-after $time_started_after --time-started-before $time_started_before



