.. _import_ips:

import ips
==========

IPS Related File


ips Specification
-----------------

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

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

	 **Element Name**                      ips

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

	 **Element Attributes**                ips_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`1834_ips_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _1834_ips_attributes:

ips attributes
--------------

    **a10-signature**

        **Description:** a10-signature is a **JSON Block**.  Please see below for :ref:`1834_a10-signature` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/import/ips/a10-signature <import_ips_a10_signature>`

    **profile**

        **Description:** profile is a **JSON Block**.  Please see below for :ref:`1834_profile` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/import/ips/profile <import_ips_profile>`

    **signature**

        **Description:** signature is a **JSON Block**.  Please see below for :ref:`1834_signature` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/import/ips/signature <import_ips_signature>`

.. _1834_profile:

profile
^^^^^^^
	=============================== ===================================================
	**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:** password

        **Maximum Length:** 16 characters

        **Maximum Length:** 1 characters

    **profile-filename**

        **Description** Specify profile

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

.. _1834_a10-signature:

a10-signature
^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **a10-signature-filename**

        **Description** Specify A10 signature file

        **Type:** string

        **Maximum Length:** 31 characters

        **Maximum Length:** 1 characters

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

.. _1834_signature:

signature
^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

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

    **signature-filename**

        **Description** Specify signature file

        **Type:** string

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