.. _export:

export
======

Put files to remote site


export Specification
--------------------

	===================================== ===============================================
	 **Parameter**                         **Value** 

	===================================== ===============================================
	 **Type**                              *operational*

	 **Element Name**                      export

	 **Element URI**                       /axapi/v3/export

	 **Element Attributes**                export_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`export schema <export/export.txt>`
	===================================== ===============================================





	**Operations Allowed:**




.. raw:: html

   <script type="text/javascript">
 function showExample(a,b) { document.getElementById(a+'_div').style.display = 'block'; document.getElementById(a+'_cl').style.display = 'block'; document.getElementById(a+'_eg').style.display = 'none';}
   function closeExample(a,b) { document.getElementById(a+'_div').style.display = 'none'; document.getElementById(a+'_cl').style.display = 'none'; document.getElementById(a+'_eg').style.display = 'block';}
 </script>
   <table width='90%' style='margin-left:5%'>



.. raw:: html

   <tr style='border-bottom: thin solid; border-top: thin solid'><th width=15%>Operation</th><th width=10%>Method</th><th>URI</th><th width=15%>Payload</th><th width=10%></th></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


EXECUTE Object



.. raw:: html

   </td><td valign = 'top'>


POST



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/export



.. raw:: html

   </td><td valign = 'top'>


:ref:`1505_export_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   </table>

.. _1505_export_attributes:

export attributes
-----------------

    **aflex**

        **Description** aFleX Script Source File

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **auth-jwks**

        **Description** Json web key

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **auth-portal**

        **Description** Portal file for http authentication

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **auth-portal-image**

        **Description** Image file for default portal

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **axdebug**

        **Description** AX Debug Packet File

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **bw-list**

        **Description** Black white List File

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **ca-cert**

        **Description** CA Cert File

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 245 characters

        **Maximum Length:** 1 characters

    **capture-config**

        **Description** Capture-config pcapng file

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **capture-config-realtime**

        **Description** Capture-config pcapng real-time file (For GUI)

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **class-list**

        **Description** Class List File

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **csr**

        **Description** Certificate Signing Request

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 245 characters

        **Maximum Length:** 1 characters

    **debug-monitor**

        **Description** Debug Monitor Output

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **debug-traffic-capture**

        **Description** Debug-Traffic-Capture pcapng file

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **debug-traffic-capture-chassis**

        **Description** Debug-Traffic-Capture pcapng file

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **debug-traffic-capture-chassis-slot**

        **Description** specify slot id in chassis

        **Type:** number

        **Range:** 0-1

    **dnssec-dnskey**

        **Description** DNSSEC DNSKEY(KSK) file for child zone

        **Type:** string

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **dnssec-ds**

        **Description** DNSSEC DS file for child zone

        **Type:** string

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **domain-list**

        **Description** Domain List File

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **externalfilename**

        **Description** Export the External Program from the System

        **Type:** string

        **Maximum Length:** 31 characters

        **Maximum Length:** 1 characters

    **fixed-nat**

        **Description** Fixed NAT Port Mapping File

        **Type:** string

        **Maximum Length:** 256 characters

        **Maximum Length:** 1 characters

    **fixed-nat-archive**

        **Description** Fixed NAT Port Mapping Archive File

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 256 characters

        **Maximum Length:** 1 characters

    **geo-location**

        **Description** Geo-location CSV File

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **geo-location-archive**

        **Description:** geo-location-archive is a **JSON Block**.  Please see below for :ref:`1505_geo-location-archive` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/export/geo-location-archive <export_geo_location_archive>`

    **ip-map-list**

        **Description** IP Map List File

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **ipsec-error-dump**

        **Description** IPsec error dump File

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **local-uri-file**

        **Description** Local URI files for http response

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **lw-4o6**

        **Description** LW-4over6 Binding Table File

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **lw-4o6-binding-table-validation-log**

        **Description** LW-4over6 Binding Table Validation Log File

        **Type:** string

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **merged-pcap**

        **Description** Export the merged pcap file when there are multiple Export sessions

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **mon-entity-debug-file**

        **Description** Enter Mon entity debug file name

        **Type:** string

        **Maximum Length:** 255 characters

        **Maximum Length:** 1 characters

    **password**

        **Description** password for the remote site

        **Type:** string

        **Format:** password

        **Maximum Length:** 16 characters

        **Maximum Length:** 1 characters

    **per-cpu**

        **Description** Export the per-cpu files along with the merged pcap file in .tgz format

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **pkt-count**

        **Description** Specify number of latest packets to export

        **Type:** number

        **Range:** 1-1000

    **pktcapture-file**

        **Description** Enter Pktcapture file name

        **Type:** string

        **Maximum Length:** 255 characters

        **Maximum Length:** 1 characters

    **profile**

        **Description** Startup-config Profile

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 31 characters

        **Maximum Length:** 1 characters

    **remote-file**

        **Description** profile name for remote url

        **Type:** string

        **Format:** url

        **Mutual Exclusion:** remote-file and store-name are mutually exclusive

    **rpz**

        **Description** Response Policy Zone File

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **running-config**

        **Description** Running Config

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **saml-idp-name**

        **Description** SAML metadata of identity provider

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **ssl-cert**

        **Description** SSL Cert File

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 245 characters

        **Maximum Length:** 1 characters

    **ssl-cert-key**

        **Description** Local SSL Key/Certificate file name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 245 characters

        **Maximum Length:** 1 characters

    **ssl-crl**

        **Description** SSL Crl File

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 255 characters

        **Maximum Length:** 1 characters

    **ssl-key**

        **Description** SSL Key File

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 245 characters

        **Maximum Length:** 1 characters

    **startup-config**

        **Description** Startup Config

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **status-check**

        **Description** check export task status

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **store**

        **Description:** store is a **JSON Block**.  Please see below for :ref:`1505_store` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/export/store <export_store>`

    **store-name**

        **Description** Export store name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** store-name and remote-file are mutually exclusive

    **syslog**

        **Description** Enter "messages" as the default syslog file name

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **tgz**

        **Description** Export the merged pcap in .tgz format

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **thales-kmdata**

        **Description** Thales Kmdata files

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **thales-secworld**

        **Description** Thales security world files

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **tsig**

        **Description** Transaction SIGnatures Key file

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **use-mgmt-port**

        **Description** Use management port as source port

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **visibility**

        **Description** Export Visibility module related files

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **xml-schema**

        **Description** XML-Schema File

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

.. _1505_geo-location-archive:

geo-location-archive
^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **geo-location-archive-name**

        **Description** 'GeoLite2-ASN-Archive': GeoLite2-ASN CSV Zipped File; 'GeoLite2-City-Archive': GeoLite2-City CSV Zipped File; 'GeoLite2-Country-Archive': GeoLite2-Country CSV Zipped File; 

        **Type:** string

        **Supported Values:** GeoLite2-ASN-Archive, GeoLite2-City-Archive, GeoLite2-Country-Archive

    **password**

        **Description** password for the remote site

        **Type:** string

        **Format:** password

        **Maximum Length:** 16 characters

        **Maximum Length:** 1 characters

    **remote-file**

        **Description** Profile name for remote url

        **Type:** string

        **Format:** url

    **use-mgmt-port**

        **Description** Use management port as source port

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

.. _1505_store:

store
^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **create**

        **Description** Create an export store profile

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **delete**

        **Description** Delete an export store profile

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **name**

        **Description** profile name to store remote url

        **Type:** string

        **Maximum Length:** 31 characters

        **Maximum Length:** 1 characters

    **remote-file**

        **Description** 

        **Type:** string

        **Format:** url