.. _import:

import
======

Get files from remote site


import Specification
--------------------

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

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

	 **Element Name**                      import

	 **Element URI**                       /axapi/v3/import

	 **Element Attributes**                import_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`import schema <import/import.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/import



.. raw:: html

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


:ref:`892_import_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _892_import_attributes:

import attributes
-----------------

    **auth-saml-idp**

        **Description:** auth-saml-idp is a **JSON Block**.  Please see below for :ref:`892_auth-saml-idp` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/import/auth-saml-idp <import_auth_saml_idp>`

    **background**

        **Description** Background mode for importing class-list

        **Type:** boolean

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

        **Default:** 0

    **certificate-type**

        **Description** 'pem': pem; 'der': der; 'pfx': pfx; 'p7b': p7b; 

        **Type:** string

        **Supported Values:** pem, der, pfx, p7b

    **class-list**

        **Description** Class List File

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **class-list-type**

        **Description** 'ac': ac; 'ipv4': ipv4; 'ipv6': ipv6; 'string': string; 'string-case-insensitive': string-case-insensitive; 

        **Type:** string

        **Supported Values:** ac, ipv4, ipv6, string, string-case-insensitive

    **csr-generate**

        **Description** Generate CSR file

        **Type:** boolean

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

        **Default:** 0

    **ddos-script**

        **Description** Python/Perl/Bash/TCL script to be used with ddos action-list

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **digest**

        **Description** 'sha1': sha1; 'sha256': sha256; 'sha384': sha384; 'sha512': sha512; 

        **Type:** string

        **Supported Values:** sha1, sha256, sha384, sha512

    **domain-list**

        **Description** Domain List File

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 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:`892_geo-location-archive` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/import/geo-location-archive <import_geo_location_archive>`

    **glm-license**

        **Description** License File

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **health-external**

        **Description:** health-external is a **JSON Block**.  Please see below for :ref:`892_health-external` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/import/health-external <import_health_external>`

    **health-postfile**

        **Description:** health-postfile is a **JSON Block**.  Please see below for :ref:`892_health-postfile` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/import/health-postfile <import_health_postfile>`

    **license**

        **Description** License File

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **overwrite**

        **Description** Overwrite existing file

        **Type:** boolean

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

        **Default:** 0

    **password**

        **Description** password for the remote site

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **pfx-password**

        **Description** The password for certificate file (pfx type only)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 128 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

    **secured**

        **Description** Mark as non-exportable

        **Type:** boolean

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

        **Default:** 0

    **ssl-cert**

        **Description** SSL Cert File(enter bulk when import an archive file)

        **Type:** string

        **Maximum Length:** 255 characters

        **Maximum Length:** 1 characters

    **ssl-cert-key**

        **Description** 'bulk': import an archive file; 

        **Type:** string

        **Supported Values:** bulk

    **ssl-key**

        **Description** SSL Key File(enter bulk when import an archive file)

        **Type:** string

        **Maximum Length:** 255 characters

        **Maximum Length:** 1 characters

    **store**

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

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/import/store <import_store>`

    **to-device**

        **Description:** to-device is a **JSON Block**.  Please see below for :ref:`892_to-device` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/import/to-device <import_to_device>`

    **use-mgmt-port**

        **Description** Use management port as source port

        **Type:** boolean

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

        **Default:** 0

    **use-ssh-key**

        **Description** Use private key to authenticate

        **Type:** boolean

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

        **Default:** 0

    **user-tag**

        **Description** Customized tag

        **Type:** string

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

.. _892_geo-location-archive:

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

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

    **geo-location-archive-format**

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

        **Type:** string

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

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

.. _892_health-external:

health-external
^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **description**

        **Description** Describe the Program Function briefly

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **externalfilename**

        **Description** Specify the Program Name

        **Type:** string

        **Maximum Length:** 31 characters

        **Maximum Length:** 1 characters

    **overwrite**

        **Description** Overwrite existing file

        **Type:** boolean

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

        **Default:** 0

    **password**

        **Description** password for the remote site

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **remote-file**

        **Description** 

        **Type:** string

        **Format:** url

    **use-mgmt-port**

        **Description** Use management port as source port

        **Type:** boolean

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

        **Default:** 0

.. _892_store:

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

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

    **create**

        **Description** Create an import store profile

        **Type:** boolean

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

        **Default:** 0

    **delete**

        **Description** Delete an import 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

.. _892_health-postfile:

health-postfile
^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **overwrite**

        **Description** Overwrite existing file

        **Type:** boolean

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

        **Default:** 0

    **password**

        **Description** password for the remote site

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **postfilename**

        **Description** Specify the File Name

        **Type:** string

        **Maximum Length:** 31 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

.. _892_to-device:

to-device
^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **device**

        **Description** Device (Device ID)

        **Type:** number

    **glm-cert**

        **Description** GLM certificate

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **glm-license**

        **Description** License File

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **overwrite**

        **Description** Overwrite existing file

        **Type:** boolean

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

        **Default:** 0

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

.. _892_auth-saml-idp:

auth-saml-idp
^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **overwrite**

        **Description** Overwrite existing file

        **Type:** boolean

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

        **Default:** 0

    **password**

        **Description** password for the remote site

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **remote-file**

        **Description** Profile name for remote url

        **Type:** string

        **Format:** url

    **saml-idp-name**

        **Description** Metadata name

        **Type:** string

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

    **verify-xml-signature**

        **Description** Verify metadata's XML signature

        **Type:** boolean

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

        **Default:** 0