vCenter ESXi Mapping Record

/api/2.0/fo/auth/vcenter/vcenter_mapping/

[POST]

List, import and purge vCenter - ESXi mapping records.

Input Parameters

Parameter

Description

action={action}

(Required) One action (list, import or purge) required for the request.

echo_request={0|1}

(Optional) Specifies whether to echo the request’s input parameters (names and values) in the XML output. When not specified, parameters are not included in the XML output. Specify 1 to view parameters in the XML output.

id_min={value}

(Optional to list) Used to filter the XML output to show only vulnerabilities that have a QID number greater than or equal to a QID number you specify.

id_max={value}

(Optional to list) Used to filter the XML output to show only vulnerabilities that have a QID number less than or equal to a QID number you specify.

output_format={XML|CSV}

(Optional to list) Specifies the format of the mapping list output. When not specified, the output format is CSV. A valid value is XML or CSV.

truncation_limit={value}

(Optional to list) Specifies the maximum number records listed per request.

vcenter_ip={value}

(Optional to list) Specifies the IP address of the vCenter.

esxi_ip={value}

(Optional to list) Specifies the IP address of the ESXi server.

network_id={1|0}

(Optional) By default, the parameter is set to 0. If this parameter is not provided, it will be Global Default Network.

csv_data={value}

(Required to import and purge) The CSV data file containing the vCenter - ESXi mapping records that you want to add/purge. This parameter or xml_data must be specified. The parameters csv_data and xml_data cannot be specified in the same request.

xml_data={value}

(Required to import and purge) The XML data file containing the vCenter - ESXi mapping records that you want to add/purge. This parameter or csv_data must be specified. The parameters csv_data and xml_data cannot be specified in the same request.

 

Sample - List vCenter - ESXi Mapping in CSV Format

API request

curl -u "USERNAME:PASSWORD" -H 'X-Requested-With: curl' "https://qualysapi.qualys.com/api/2.0/fo/auth/vcenter/vcenter_mapping/?action=list"

or

curl -u "USERNAME:PASSWORD" -H 'X-Requested-With: curl' "https://qualysapi.qualys.com/api/2.0/fo/auth/vcenter/vcenter_mapping/?action=list&output_format=csv"

 

CSV output

----BEGIN_RESPONSE_BODY_CSV

vCenter IP,ESXi IP,Mapping Data Source

"11.11.11.11","30.30.30.23","File"

"10.10.10.10","10.10.10.12","File"

----END_RESPONSE_BODY_CSV

----BEGIN_RESPONSE_FOOTER_CSV

"Status Message"

"Finished"

----END_RESPONSE_FOOTER_CSV

Sample - List vCenter - ESXi Mapping in XML Format

API request

curl -u "USERNAME:PASSWORD" -H 'X-Requested-With: curl' "https://qualysapi.qualys.com/api/2.0/fo/auth/vcenter/vcenter_mapping/?action=list&output_format=xml"

 

XML output

<?xml version="1.0" encoding="UTF-8" ?>

<!DOCTYPE VCENTER_ESXI_MAP_LIST_OUTPUT SYSTEM "https://qualysapi.qualys.com/api/2.0/fo/auth/vcenter/vcenter_mapping/vcenter_esxi_map_list_output.dtd">

<VCENTER_ESXI_MAP_LIST_OUTPUT>

    <RESPONSE>

        <DATETIME>2020-05-22T16:49:40Z</DATETIME>

        <VCENTER_ESXI_MAP_LIST>

            <VCENTER_ESXI_MAP>

                <VCENTER_IP>11.11.11.11</VCENTER_IP>

                <ESXI_IP>30.30.30.23</ESXI_IP>

                <MAPPING_DATA_SOURCE>File</MAPPING_DATA_SOURCE>

            </VCENTER_ESXI_MAP>

            <VCENTER_ESXI_MAP>

                <VCENTER_IP>10.10.10.10</VCENTER_IP>

                <ESXI_IP>10.10.10.12</ESXI_IP>

                <MAPPING_DATA_SOURCE>File</MAPPING_DATA_SOURCE>

            </VCENTER_ESXI_MAP>

        </VCENTER_ESXI_MAP_LIST>

    </RESPONSE>

</VCENTER_ESXI_MAP_LIST_OUTPUT>

Sample - Import vCenter - ESXi Mapping

API request when CSV data in call

curl -u "USERNAME:PASSWORD" -H 'X-Requested-With: curl' --data-binary "action=import&csv_data=vCenter IP,ESXi IP%0A10.10.10.10,10.10.10.11%0A10.10.10.10,10.10.10.12" "https://qualysapi.qualys.com/api/2.0/fo/auth/vcenter/vcenter_mapping/"

 

API request when XML data in call

curl -u "USERNAME:PASSWORD" -H 'X-Requested-With: curl' --data-binary "action=import&xml_data=<VCENTER_ESXI_MAP_LIST><VCENTER_ESXI_MAP><VCENTER_IP>11.11.11.11</VCENTER_IP><ESXI_IP>22.22.22.22</ESXI_IP></VCENTER_ESXI_MAP><VCENTER_ESXI_MAP><VCENTER_IP>11.11.11.12</VCENTER_IP><ESXI_IP>22.22.22.23</ESXI_IP></VCENTER_ESXI_MAP></VCENTER_ESXI_MAP_LIST>" "https://qualysapi.qualys.com/api/2.0/fo/auth/vcenter/vcenter_mapping/"

 

API request when CSV data in a file

curl -u "USERNAME:PASSWORD" -H 'X-Requested-with: curl' --data-binary "@add.csv"  "https://qualysapi.qualys.com/api/2.0/fo/auth/vcenter/vcenter_mapping/"

 

Sample content of add.csv file

action=import&csv_data=

vCenter IP,ESXi IP

10.10.10.10,20.20.20.20

10.10.10.10,20.20.20.21

10.10.10.10,20.20.20.22

11.11.11.11,30.30.30.23

12.12.12.12,40.40.40.24

 

API request when XML data in a file

curl -u "USERNAME:PASSWORD" -H 'X-Requested-with: curl' --data-binary "@add.xml"  "https://qualysapi.qualys.com/api/2.0/fo/auth/vcenter/vcenter_mapping/"

 

Sample content of add.xml file

action=import&xml_data=

<?xml version="1.0" encoding="UTF-8" ?>

<VCENTER_ESXI_MAP_LIST>

    <VCENTER_ESXI_MAP>

        <VCENTER_IP>10.10.10.10</VCENTER_IP>

        <ESXI_IP>20.20.20.21</ESXI_IP>

    </VCENTER_ESXI_MAP>

    <VCENTER_ESXI_MAP>

        <VCENTER_IP>10.10.10.10</VCENTER_IP>

        <ESXI_IP>20.20.20.22</ESXI_IP>

    </VCENTER_ESXI_MAP>

</VCENTER_ESXI_MAP_LIST>

 

XML output

<?xml version="1.0" encoding="UTF-8" ?>

<!DOCTYPE SIMPLE_RETURN SYSTEM "https://qualysapi.qualys.com/api/2.0/simple_return.dtd">

<SIMPLE_RETURN>

  <RESPONSE>

    <DATETIME>2020-05-07T10:57:23Z</DATETIME>

    <TEXT>Successfully imported 2 records</TEXT>

  </RESPONSE>

</SIMPLE_RETURN>

Sample - Purge vCenter - ESXi Mapping

API request when CSV data in call

curl -u "USERNAME:PASSWORD" -H 'X-Requested-With: curl' --data-binary "action=purge&csv_data=vCenter IP,ESXi IP%0A10.10.10.10,10.10.10.11%0A10.10.10.10,10.10.10.12" "https://qualysapi.qualys.com/api/2.0/fo/auth/vcenter/vcenter_mapping/"

 

API request when XML data in call

curl -u "USERNAME:PASSWORD" -H 'X-Requested-With: curl' --data-binary "action=purge&xml_data=<VCENTER_ESXI_MAP_LIST><VCENTER_ESXI_MAP><VCENTER_IP>11.11.11.11</VCENTER_IP><ESXI_IP>22.22.22.22</ESXI_IP></VCENTER_ESXI_MAP><VCENTER_ESXI_MAP><VCENTER_IP>11.11.11.12</VCENTER_IP><ESXI_IP>22.22.22.23</ESXI_IP></VCENTER_ESXI_MAP></VCENTER_ESXI_MAP_LIST>" "https://qualysapi.qualys.com/api/2.0/fo/auth/vcenter/vcenter_mapping/"

 

API request when CSV data in a file

curl -u "USERNAME:PASSWORD" -H 'X-Requested-with: curl' --data-binary "@purge.csv"  "https://qualysapi.qualys.com/api/2.0/fo/auth/vcenter/vcenter_mapping/"

 

Sample content of purge.csv file

action=purge&csv_data=

vCenter IP,ESXi IP

10.10.10.10,20.20.20.20

10.10.10.10,20.20.20.21

10.10.10.10,20.20.20.22

11.11.11.11,30.30.30.23

12.12.12.12,40.40.40.24

 

API request when XML data in a file

curl -u "USERNAME:PASSWORD" -H 'X-Requested-with: curl' --data-binary "@purge.xml"  "https://qualysapi.qualys.com/api/2.0/fo/auth/vcenter/vcenter_mapping/"

 

Sample content of purge.xml file

action=purge&xml_data=

<?xml version="1.0" encoding="UTF-8" ?>

<VCENTER_ESXI_MAP_LIST>

    <VCENTER_ESXI_MAP>

        <VCENTER_IP>10.10.10.10</VCENTER_IP>

        <ESXI_IP>20.20.20.21</ESXI_IP>

    </VCENTER_ESXI_MAP>

    <VCENTER_ESXI_MAP>

        <VCENTER_IP>10.10.10.10</VCENTER_IP>

        <ESXI_IP>20.20.20.22</ESXI_IP>

    </VCENTER_ESXI_MAP>

</VCENTER_ESXI_MAP_LIST>

 

XML output

<?xml version="1.0" encoding="UTF-8" ?>

<!DOCTYPE SIMPLE_RETURN SYSTEM "https://qualysapi.qualys.com/api/2.0/simple_return.dtd">

<SIMPLE_RETURN>

  <RESPONSE>

    <DATETIME>2020-05-07T10:57:23Z</DATETIME>

    <TEXT>Successfully purged 2 records</TEXT>

  </RESPONSE>

</SIMPLE_RETURN>

DTDs for  "vCenter - ESXi Mapping"

<platform API server>/api/2.0/fo/auth/vcenter/vcenter_mapping/vcenter_esxi_map_list_output.dtd