This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Network Logging

Overview

Provides a Command-line Interface (CLI) that supports programmatic use of IaaS/PaaS products provided by SCP.

This guide provides a brief description of Network Logging service and how to call CLI. The output is formatted as a JSON string

Version

VersionStatusSupported Until
1.0CURRENT-

1 - CLIs

1.1 - Create Network Logging Storage

1.1.1 - 1.0

scpcli network-logging network-logging-storage create
--resource_type <value>
--bucket_name <value>

Description

Create Network Logging Storage.

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
resource_type
required
stringResource Type-
bucket_name
required
stringStorage Bucket Name-

Responses

NameDescriptionExample
idNetwork Logging Storage ID
account_idAccount ID
bucket_nameStorage Bucket Name
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
resource_typeResource Type

1.2 - Delete Network Logging Storage

1.2.1 - 1.0

scpcli network-logging network-logging-storage delete
--network_logging_storage_id <value>

Description

Delete Network Logging Storage.

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
network_logging_storage_id
required
stringNetwork Logging Storage ID-

1.3 - List Network Logging Configurations

1.3.1 - 1.0

scpcli network-logging network-logging-configuration list
--resource_type <value>
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]
[--resource_id <value>]
[--resource_name <value>]

Description

Get Network Logging Configuration list.

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
resource_type
required
****Resource Type-
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc
resource_id
optional
stringResource ID-
resource_name
optional
stringResource Name-

Responses

NameDescriptionExample
idNetwork Logging Configuration ID
account_idAccount ID
bucket_nameStorage Bucket Name
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
down_interfaceDownlink Interface
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
resource_idResource ID
resource_nameResource Name
resource_typeResource Type
security_group_log_idSecurity Group Log ID
up_interfaceUplink Interface

1.4 - List Network Logging Storages

1.4.1 - 1.0

scpcli network-logging network-logging-storage list
--resource_type <value>
[--with_count <value>]
[--limit <value>]
[--marker <value>]
[--sort <value>]

Description

Get Network Logging Storage list.

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
resource_type
required
****Resource Type-
with_count
optional
stringwith counttrue
limit
optional
integerlimit20
marker
optional
stringmarker607e0938521643b5b4b266f343fae693
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
idNetwork Logging Storage ID
account_idAccount ID
bucket_nameStorage Bucket Name
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
resource_typeResource Type