.. _export_periodic: export-periodic =============== Put files to remote site periodically export-periodic Specification ----------------------------- ===================================== ================================================================== **Parameter** **Value** ===================================== ================================================================== **Type** *Collection* **Object Key(s)** *axdebug* **Collection Name** :ref:`646_export-periodic_list` **Collection URI** /axapi/v3/export-periodic **Element Name** export-periodic **Element URI** /axapi/v3/export-periodic/{axdebug} **Element Attributes** export-periodic_attributes **Partition Visibility** None **Schema** :download:`export-periodic schema ` ===================================== ================================================================== **Operations Allowed:** .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html
OperationMethodURIPayload
Create Object .. raw:: html POST .. raw:: html /axapi/v3/export-periodic .. raw:: html :ref:`646_export-periodic_attributes` .. raw:: html
Create List .. raw:: html POST .. raw:: html /axapi/v3/export-periodic .. raw:: html :ref:`646_export-periodic_attributes` .. raw:: html
Get Object .. raw:: html GET .. raw:: html /axapi/v3/export-periodic/{axdebug} .. raw:: html :ref:`646_export-periodic_attributes` .. raw:: html
Get List .. raw:: html GET .. raw:: html /axapi/v3/export-periodic .. raw:: html :ref:`646_export-periodic_list` .. raw:: html
Modify Object .. raw:: html POST .. raw:: html /axapi/v3/export-periodic/{axdebug} .. raw:: html :ref:`646_export-periodic_attributes` .. raw:: html
Replace Object .. raw:: html PUT .. raw:: html /axapi/v3/export-periodic/{axdebug} .. raw:: html :ref:`646_export-periodic_attributes` .. raw:: html
Replace List .. raw:: html PUT .. raw:: html /axapi/v3/export-periodic .. raw:: html :ref:`646_export-periodic_list` .. raw:: html
Delete Object .. raw:: html DELETE .. raw:: html /axapi/v3/export-periodic/{axdebug} .. raw:: html :ref:`646_export-periodic_attributes` .. raw:: html
.. _646_export-periodic_list: export-periodic-list -------------------- export-periodic-list is **JSON List** of :ref:`646_export-periodic_attributes` export-periodic-list : [ { :ref:`646_export-periodic_attributes` }, { :ref:`646_export-periodic_attributes` }, ... ] .. _646_export-periodic_attributes: export-periodic attributes -------------------------- **aflex-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/export-periodic/{axdebug}/aflex/{aflex} ` **auth-portal-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/export-periodic/{axdebug}/auth-portal/{auth-portal} ` **axdebug** **Description** AX Debug Packet File **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **axdebug-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/export-periodic/{axdebug}/axdebug/{axdebug} ` **bw-list-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/export-periodic/{axdebug}/bw-list/{bw-list} ` **class-list-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/export-periodic/{axdebug}/class-list/{class-list} ` **debug-monitor-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/export-periodic/{axdebug}/debug-monitor/{debug-monitor} ` **dnssec-dnskey-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/export-periodic/{axdebug}/dnssec-dnskey/{dnssec-dnskey} ` **dnssec-ds-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/export-periodic/{axdebug}/dnssec-ds/{dnssec-ds} ` **domain-list-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/export-periodic/{axdebug}/domain-list/{domain-list} ` **geo-location-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/export-periodic/{axdebug}/geo-location/{geo-location} ` **ip-map-list-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/export-periodic/{axdebug}/ip-map-list/{ip-map-list} ` **local-uri-file-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/export-periodic/{axdebug}/local-uri-file/{local-uri-file} ` **merged-pcap** **Description** Export the merged pcap file when there are multiple Export sessions **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **period** **Description** Specify the period in second **Type:** number **Range:** 60-31536000 **policy-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/export-periodic/{axdebug}/policy/{policy} ` **remote-file** **Description** profile name for remote url **Type:** string **Format:** url **ssl-cert-key-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/export-periodic/{axdebug}/ssl-cert-key/{ssl-cert-key} ` **ssl-cert-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/export-periodic/{axdebug}/ssl-cert/{ssl-cert} ` **ssl-crl-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/export-periodic/{axdebug}/ssl-crl/{ssl-crl} ` **ssl-key-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/export-periodic/{axdebug}/ssl-key/{ssl-key} ` **syslog-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/export-periodic/{axdebug}/syslog/{syslog} ` **thales-secworld-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/export-periodic/{axdebug}/thales-secworld/{thales-secworld} ` **use-mgmt-port** **Description** Use management port as source port **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters **wsdl-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/export-periodic/{axdebug}/wsdl/{wsdl} ` **xml-schema-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/export-periodic/{axdebug}/xml-schema/{xml-schema} ` .. _646_ssl-cert-list: ssl-cert-list ^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **period** **Description** Specify the period in second **Type:** number **Range:** 60-31536000 **remote-file** **Description** profile name for remote url **Type:** string **Format:** url **ssl-cert** **Description** SSL Cert File **Type:** string **Maximum Length:** 255 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 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _646_geo-location-list: geo-location-list ^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **geo-location** **Description** Geo-location CSV File **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **period** **Description** Specify the period in second **Type:** number **Range:** 60-31536000 **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 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _646_wsdl-list: wsdl-list ^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **period** **Description** Specify the period in second **Type:** number **Range:** 60-31536000 **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 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters **wsdl** **Description** Web Services Definition Language File **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters .. _646_syslog-list: syslog-list ^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **period** **Description** Specify the period in second **Type:** number **Range:** 60-31536000 **remote-file** **Description** profile name for remote url **Type:** string **Format:** url **syslog** **Description** Syslog file **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 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _646_xml-schema-list: xml-schema-list ^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **period** **Description** Specify the period in second **Type:** number **Range:** 60-31536000 **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 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters **xml-schema** **Description** XML-Schema File **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters .. _646_debug-monitor-list: debug-monitor-list ^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **debug-monitor** **Description** Debug Monitor Output **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **period** **Description** Specify the period in second **Type:** number **Range:** 60-31536000 **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 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _646_aflex-list: aflex-list ^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **aflex** **Description** aFleX Script Source File **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **period** **Description** Specify the period in second **Type:** number **Range:** 60-31536000 **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 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _646_dnssec-dnskey-list: dnssec-dnskey-list ^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **dnssec-dnskey** **Description** DNSSEC DNSKEY(KSK) file for child zone **Type:** string **Maximum Length:** 127 characters **Maximum Length:** 1 characters **period** **Description** Specify the period in second **Type:** number **Range:** 60-31536000 **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 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _646_ssl-cert-key-list: ssl-cert-key-list ^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **period** **Description** Specify the period in second **Type:** number **Range:** 60-31536000 **remote-file** **Description** profile name for remote url **Type:** string **Format:** url **ssl-cert-key** **Description** Local SSL Key/Certificate file name **Type:** string **Maximum Length:** 255 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 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _646_domain-list-list: domain-list-list ^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **domain-list** **Description** Domain List File **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **period** **Description** Specify the period in second **Type:** number **Range:** 60-31536000 **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 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _646_ssl-key-list: ssl-key-list ^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **period** **Description** Specify the period in second **Type:** number **Range:** 60-31536000 **remote-file** **Description** profile name for remote url **Type:** string **Format:** url **ssl-key** **Description** SSL Key File **Type:** string **Maximum Length:** 255 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 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _646_local-uri-file-list: local-uri-file-list ^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **local-uri-file** **Description** Local URI files for http response **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **period** **Description** Specify the period in second **Type:** number **Range:** 60-31536000 **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 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _646_class-list-list: class-list-list ^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **class-list** **Description** Class List Name **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **period** **Description** Specify the period in second **Type:** number **Range:** 60-31536000 **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 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _646_bw-list-list: bw-list-list ^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **bw-list** **Description** Black white List File **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **period** **Description** Specify the period in second **Type:** number **Range:** 60-31536000 **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 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _646_ip-map-list-list: ip-map-list-list ^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ip-map-list** **Description** IP Map List File **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **period** **Description** Specify the period in second **Type:** number **Range:** 60-31536000 **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 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _646_ssl-crl-list: ssl-crl-list ^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **period** **Description** Specify the period in second **Type:** number **Range:** 60-31536000 **remote-file** **Description** profile name for remote url **Type:** string **Format:** url **ssl-crl** **Description** SSL Crl File **Type:** string **Maximum Length:** 255 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 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _646_auth-portal-list: auth-portal-list ^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **auth-portal** **Description** Portal file for http authentication **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **period** **Description** Specify the period in second **Type:** number **Range:** 60-31536000 **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 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _646_policy-list: policy-list ^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **period** **Description** Specify the period in second **Type:** number **Range:** 60-31536000 **policy** **Description** WAF Policy File **Type:** string **Maximum Length:** 63 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 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _646_axdebug-list: axdebug-list ^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **axdebug** **Description** AX Debug Packet File **Type:** string **Maximum Length:** 63 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 **period** **Description** Specify the period in second **Type:** number **Range:** 60-31536000 **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 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _646_thales-secworld-list: thales-secworld-list ^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **overwrite** **Description** Overwrite existing file **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **period** **Description** Specify the period in second **Type:** number **Range:** 60-31536000 **remote-file** **Description** profile name for remote url **Type:** string **Format:** url **thales-secworld** **Description** export Thales security world files - in .tgz format that has all files needed by AX **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 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _646_dnssec-ds-list: dnssec-ds-list ^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **dnssec-ds** **Description** DNSSEC DS file for child zone **Type:** string **Maximum Length:** 127 characters **Maximum Length:** 1 characters **period** **Description** Specify the period in second **Type:** number **Range:** 60-31536000 **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 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters