security_order methods¶

class ecl.security_order.v1._proxy.Proxy(session)[source]¶

Bases: ecl.proxy2.BaseProxy

cancel_hbs(mailaddress, locale=None)[source]¶

Cancel the order of Host-based Security.

Parameters:	mailaddress (string) – Contactable mail address. locale (string) – Messages are displayed in Japanese or English depending on this value. ja: Japanese, en: English. Default value is “en”.
Returns:	Host Based Security.
Return type:	`HostBasedSecurity`

change_hbs_menu(service_order_service, mailaddress, locale=None)[source]¶

Change menu of Host-based Security.

Parameters:	service_order_service (string) – Requested menu. Set “Managed Anti-Virus”, “Managed Virtual Patch” or “Managed Host-based Security Package” to this field. mailaddress (string) – Contactable mail address. locale (string) – Messages are displayed in Japanese or English depending on this value. ja: Japanese, en: English. Default value is “en”.
Returns:	Host Based Security.
Return type:	`HostBasedSecurity`

change_hbs_quantity(max_agent_value, mailaddress, locale=None)[source]¶

Change maximum quantity of Agent usage.

Parameters:	max_agent_value (string) – Set maximum quantity of Agenet usage. mailaddress (string) – Contactable mail address. locale (string) – Messages are displayed in Japanese or English depending on this value. ja: Japanese, en: English. Default value is “en”.
Returns:	Host Based Security.
Return type:	`HostBasedSecurity`

create_device(operatingmode, licensekind, azgroup, locale=None)[source]¶

Create a new Managed Firewall/UTM device of single constitution.

Parameters:	operatingmode (string) – Set “FW” or “UTM” to this value. licensekind (string) – Set “02” or “08” as FW/UTM plan. azgroup (string) – Availability Zone locale (string) – Messages are displayed in Japanese or English depending on this value. ja: Japanese, en: English. Default value is “en”.
Returns:	Single Firwall/UTM.
Return type:	`Device`

create_ha_device(operatingmode, licensekind, azgroup1, azgroup2, halink1networkid, halink1subnetid, halink1ipaddress1, halink1ipaddress2, halink2networkid, halink2subnetid, halink2ipaddress1, halink2ipaddress2, locale=None)[source]¶

Create a new Managed Firewall/UTM device of single constitution.

Parameters:	operatingmode (string) – Set “UTM_HA” or “FW_HA” to this value. licensekind (string) – Set “02” or “08” as FW/UTM plan. azgroup1 (string) – Availability Zone azgroup2 (string) – Availability Zone halink1networkid (string) – Set Network ID to be used for HA line. halink1subnetid (string) – Set Subnet ID to be used for HA line. halink1ipaddress1 (string) – Set value of IPv4. halink1ipaddress2 (string) – Set value of IPv4. halink2networkid (string) – Set Network ID to be used for HA line. halink2subnetid (string) – Set Subnet ID to be used for HA line. halink2ipaddress1 (string) – Set value of IPv4. halink2ipaddress2 (string) – Set value of IPv4. locale (string) – Messages are displayed in Japanese or English depending on this value. ja: Japanese, en: English. Default value is “en”.
Returns:	HA Firwall/UTM.
Return type:	`HADevice`

create_waf(licensekind, azgroup, locale=None)[source]¶

Create a new WAF device.

Parameters:	licensekind (string) – Set “02”, “04” or “08” as WAF plan. azgroup (string) – Availability Zone locale (string) – Messages are displayed in Japanese or English depending on this value. ja: Japanese, en: English. Default value is “en”.
Returns:	WAF.
Return type:	`WAF`

delete_device(hostname, locale=None)[source]¶

Delete a Managed Firewall/UTM device of single constitution.

Parameters:	hostname (string) – Set the hostname. locale (string) – Messages are displayed in Japanese or English depending on this value. ja: Japanese, en: English. Default value is “en”.
Returns:	Single Firwall/UTM.
Return type:	`Device`

delete_ha_device(hostname1, hostname2, locale=None)[source]¶

Delete a Managed Firewall/UTM device of single constitution.

Parameters:	hostname1 (string) – Set the hostname. hostname2 (string) – Set the hostname. locale (string) – Messages are displayed in Japanese or English depending on this value. ja: Japanese, en: English. Default value is “en”.
Returns:	HA Firwall/UTM.
Return type:	`HADevice`

delete_waf(hostname, locale=None)[source]¶

Delete a WAF device.

Parameters:	hostname (string) – Set the hostname. locale (string) – Messages are displayed in Japanese or English depending on this value. ja: Japanese, en: English. Default value is “en”.
Returns:	WAF.
Return type:	`WAF`

devices(locale=None)[source]¶

List Managed Firwall/UTM devices of single constitution.

Parameters:	locale (string) – Messages are displayed in Japanese or English depending on this value. ja: Japanese, en: English. Default value is “en”.
Returns:	Single Firwall/UTM.
Return type:	`Device`

get_device_order_status(soid, locale=None)[source]¶

Check progress status of Managed Firewall/UTM device Service Order.

Parameters:	soid (string) – This value is returned value of when you execute Create Server, Update Server or Delete Server API. locale (string) – Messages are displayed in Japanese or English depending on this value. ja: Japanese, en: English. Default value is “en”.
Returns:	Single Firwall/UTM.
Return type:	`Device`

get_hbs_order_info(locale=None)[source]¶

Get Order Information that tied to tenant id.

Parameters:	locale (string) – Messages are displayed in Japanese or English depending on this value. ja: Japanese, en: English. Default value is “en”.
Returns:	Host Based Security.
Return type:	`HostBasedSecurity`

get_hbs_order_status(soid, locale=None)[source]¶

Check progress status of Host-based Security Service Order.

Parameters:	soid (string) – This value is returned value of when you execute API of Order Host-based Security, Change menu or quantity, or Cancel the order. locale (string) – Messages are displayed in Japanese or English depending on this value. ja: Japanese, en: English. Default value is “en”.
Returns:	Host Based Security.
Return type:	`HostBasedSecurity`

get_waf_order_status(soid, locale=None)[source]¶

Check progress status of Managed WAF device Service Order.

Parameters:	soid (string) – This value is returned value of when you execute Create Server, Update Server or Delete Server API. locale (string) – Messages are displayed in Japanese or English depending on this value. ja: Japanese, en: English. Default value is “en”.
Returns:	WAF.
Return type:	`WAF`

ha_devices(locale=None)[source]¶

List Managed Firwall/UTM devices of single constitution.

Parameters:	locale (string) – Messages are displayed in Japanese or English depending on this value. ja: Japanese, en: English. Default value is “en”.
Returns:	HA Firwall/UTM.
Return type:	`HADevice`

order_hbs(service_order_service, max_agent_value, mailaddress, dsm_lang, time_zone, locale=None)[source]¶

Make a new application for Host-based Security.

Parameters:	service_order_service (string) – Requested menu. Set “Managed Anti-Virus”, “Managed Virtual Patch” or “Managed Host-based Security Package” to this field. max_agent_value (string) – Set maximum quantity of Agenet usage. mailaddress (string) – Contactable mail address. dsm_lang (string) – This value is used for language of Deep Security Manager. ja: Japanese, en: English. time_zone (string) – Set “Asia/Tokyo” for JST or “Etc/GMT” for UTC. locale (string) – Messages are displayed in Japanese or English depending on this value. ja: Japanese, en: English. Default value is “en”.
Returns:	Host Based Security
Return type:	`HostBasedSecurity`

update_device(hostname, operatingmode, licensekind, locale=None)[source]¶

Change menu (Firewall/Managed UTM) and/or plan of single device.

Parameters:	operatingmode (string) – Set “FW” or “UTM” to this value. licensekind (string) – Set “02” or “08” as FW/UTM plan. hostname (string) – Set the hostname. locale (string) – Messages are displayed in Japanese or English depending on this value. ja: Japanese, en: English. Default value is “en”.
Returns:	Single Firwall/UTM.
Return type:	`Device`

update_ha_device(hostname1, hostname2, operatingmode, licensekind, locale=None)[source]¶

Change menu (Firewall/Managed UTM) and/or plan of single device.

Parameters:	hostname1 (string) – Set the hostname. hostname2 (string) – Set the hostname. operatingmode (string) – Set “UTM_HA” or “FW_HA” to this value. licensekind (string) – Set “02” or “08” as FW/UTM plan. locale (string) – Messages are displayed in Japanese or English depending on this value. ja: Japanese, en: English. Default value is “en”.
Returns:	HA Firwall/UTM.
Return type:	`HADevice`

update_waf(hostname, licensekind, locale=None)[source]¶

Change plan of device.

Parameters:	licensekind (string) – Set “02”, “04” or “08” as WAF plan. hostname (string) – Set the hostname. locale (string) – Messages are displayed in Japanese or English depending on this value. ja: Japanese, en: English. Default value is “en”.
Returns:	WAF.
Return type:	`WAF`

wafs(locale=None)[source]¶

List active waf devices you ordered.

Parameters:	locale (string) – Messages are displayed in Japanese or English depending on this value. ja: Japanese, en: English. Default value is “en”.
Returns:	WAF.
Return type:	`WAF`

device¶

class ecl.security_order.v1.device.Device(synchronized=False, **attrs)[source]¶

Bases: ecl.resource2.Resource

allow_create = True¶

allow_delete = True¶

allow_get = True¶

allow_list = True¶

allow_update = True¶

base_path = '/API/SoEntryFGS'¶

code = None¶: This value indicates normal or abnormal. 1:normal, 2:abnormal.

delete(session, body, locale=None)[source]¶

devices = None¶: List of device objects.

get_order_status(session, soid, locale=None)[source]¶

gt_host = None¶: List of following objects. operatingmode: Set “FW” or “UTM” to this value. licensekind: Set “02” or “08” as FW/UTM plan. azgroup: Availability Zone.

list(session, locale=None)[source]¶

locale = None¶: Messages are displayed in Japanese or English depending on this value. ja: Japanese, en: English. Default value is “en”.

message = None¶: This message is shown when error has occurred.

progress_rate = None¶: Percentage of Service Order Progress Status.

records = None¶: Number of devices.

resource_key = None¶

resources_key = None¶

rows = None¶: Device list.

service = {'region_name': None, 'service_name': None, 'interface': 'public', 'version': None, 'service_type': 'mss-rfg', 'requires_project_id': False, 'api_version': None}¶

soid = None¶: Identification ID of Service Order.

sokind = None¶: A: Create Single Constitution Device. M: Update Single Constitution Device. D: Delete Single Constitution Device.

status = None¶: This value indicates normal or abnormal. 1:normal, 2:abnormal.

tenant_id = None¶: Tenant ID of the owner (UUID).

update(session, **body)[source]¶

ha_device¶

class ecl.security_order.v1.ha_device.HADevice(synchronized=False, **attrs)[source]¶

Bases: ecl.resource2.Resource

allow_create = True¶

allow_delete = True¶

allow_get = True¶

allow_list = True¶

allow_update = True¶

base_path = '/API/SoEntryFGHA'¶

code = None¶: This value indicates normal or abnormal. 1:normal, 2:abnormal.

delete(session, body, locale=None)[source]¶

devices = None¶: List of device objects.

gt_host = None¶: List of following objects. operatingmode: Set “FW” or “UTM” to this value. licensekind: Set “02” or “08” as FW/UTM plan. azgroup: Availability Zone.

list(session, locale=None)[source]¶

locale = None¶: Messages are displayed in Japanese or English depending on this value. ja: Japanese, en: English. Default value is “en”.

message = None¶: This message is shown when error has occurred.

progress_rate = None¶: Percentage of Service Order Progress Status.

records = None¶: Number of devices.

resource_key = None¶

resources_key = None¶

rows = None¶: Device list.

service = {'region_name': None, 'service_name': None, 'interface': 'public', 'version': None, 'service_type': 'mss-rfg', 'requires_project_id': False, 'api_version': None}¶

soid = None¶: Identification ID of Service Order.

sokind = None¶: A: Create Single Constitution Device. M: Update Single Constitution Device. D: Delete Single Constitution Device.

status = None¶: This value indicates normal or abnormal. 1:normal, 2:abnormal.

tenant_id = None¶: Tenant ID of the owner (UUID).

update(session, **body)[source]¶

host_based_security¶

class ecl.security_order.v1.host_based_security.HostBasedSecurity(synchronized=False, **attrs)[source]¶

Bases: ecl.resource2.Resource

allow_create = True¶

allow_delete = True¶

allow_get = True¶

allow_list = True¶

allow_update = True¶

base_path = '/API/SoEntryHBS'¶

code = None¶: This value indicates normal or abnormal. 1:normal, 2:abnormal.

contract_id = None¶: Contract ID which this tenant belongs to.

customer_name = None¶: Customer Name.

delete(session, body, locale=None)[source]¶

dsm_lang = None¶: This value is used for language of Deep Security Manager. ja: Japanese, en: English.

get_order_info(session, locale=None)[source]¶

get_order_status(session, soid, locale=None)[source]¶

locale = None¶: Messages are displayed in Japanese or English depending on this value. ja: Japanese, en: English. Default value is “en”.

mailaddress = None¶: Contactable mail address.

max_agent_value = None¶: Set maximum quantity of Agenet usage.

message = None¶: This message is shown when error has occurred.

progress_rate = None¶: Percentage of Service Order Progress Status.

region = None¶: Region tenant you specified belongs to.

resource_key = None¶

resources_key = None¶

service = {'region_name': None, 'service_name': None, 'interface': 'public', 'version': None, 'service_type': 'mss-rfg', 'requires_project_id': False, 'api_version': None}¶

service_order_service = None¶: Requested menu. Set “Managed Anti-Virus”, “Managed Virtual Patch” or “Managed Host-based Security Package” to this field.

soid = None¶: Identification ID of Service Order.

sokind = None¶: N: Order New Host-based Security. M1: Change menu of Host-based Security. M2: Change quantity of Host-based Security. C: Cancel Host-based Security.

status = None¶: This value indicates normal or abnormal. 1:normal, 2:abnormal.

tenant_description = None¶: Description for this tenant.

tenant_flg = None¶: Internal Use. (true: Already applied, false: Not applied.)

tenant_id = None¶: Tenant ID of the owner (UUID).

tenant_name = None¶: Tenant Name.

time_zone = None¶: Set “Asia/Tokyo” for JST or “Etc/GMT” for UTC.

update(session, **body)[source]¶

waf¶

class ecl.security_order.v1.waf.WAF(synchronized=False, **attrs)[source]¶

Bases: ecl.resource2.Resource

allow_create = True¶

allow_delete = True¶

allow_get = True¶

allow_list = True¶

allow_update = True¶

base_path = '/API/SoEntryFGWAF'¶

code = None¶: This value indicates normal or abnormal. 1:normal, 2:abnormal.

delete(session, body, locale=None)[source]¶

devices = None¶: List of device objects.

get_order_status(session, soid, locale=None)[source]¶

gt_host = None¶: List of following objects. operatingmode: Set “WAF” to this value. licensekind: Set “02”, “04” or “08” as WAF plan. azgroup: Availability Zone.

list(session, locale=None)[source]¶

locale = None¶: Messages are displayed in Japanese or English depending on this value. ja: Japanese, en: English. Default value is “en”.

message = None¶: This message is shown when error has occurred.

progress_rate = None¶: Percentage of Service Order Progress Status.

records = None¶: Number of devices.

resource_key = None¶

resources_key = None¶

rows = None¶: Device list.

service = {'region_name': None, 'service_name': None, 'interface': 'public', 'version': None, 'service_type': 'mss-rfg', 'requires_project_id': False, 'api_version': None}¶

soid = None¶: Identification ID of Service Order.

sokind = None¶: A: Create Single Constitution Device. M: Update Single Constitution Device. D: Delete Single Constitution Device.

status = None¶: This value indicates normal or abnormal. 1:normal, 2:abnormal.

tenant_id = None¶: Tenant ID of the owner (UUID).

update(session, **body)[source]¶