Resource net | Mars OS REST APIs

Resource /webmapi/netExpand | Collapse

APIs for network interfaces

GET /webmapi/net/interfaces/fc

Show the Fibre Channel target (FCP) interfaces

Description

Show the Fibre Channel target (FCP) interfaces

HTTP Example

GET /webmapi/net/interfaces/fc

Output

Reports successful result in ResponseContentType<ContainerType<LifInfoType>>

Errors

Reports errors in ResponseContentType<ErrorType>

Error Key	Error Code	Error Description
LIF_SHOW_LIF_NOT_FOUND	11003	Interface not found.

Produces

application/json

Since

1.0

GET /webmapi/net/interfaces/fc/{id}

Get a specified LIF instance

Description

Get a specified LIF instance

HTTP Example

GET /webmapi/net/interfaces/fc/{id}

Path Parameters:

idThe ID or name of the instance (required=true).

Output

Reports successful result in ResponseContentType<LifInfoType>

Errors

Reports errors in ResponseContentType<ErrorType>

Error Key	Error Code	Error Description
LIF_SHOW_LIF_NOT_FOUND	11003	Interface not found.

Produces

application/json

Since

1.0

PUT /webmapi/net/interfaces/fc/{id}/action/offline

Offline an online SAN interface

Description

Offline an online SAN interface

HTTP Example

PUT /webmapi/net/interfaces/fc/{id}/action/offline

Path Parameters:

idThe ID or name of the instance (required=true).

Output

Reports successful result in ResponseContentType

Errors

Reports errors in ResponseContentType<ErrorType>

Error Key	Error Code	Error Description
LIF_OFFLINE_LIF_NOT_FOUND	11001	Interface not found.
LIF_OFFLINE_LIF_NOT_ONLINE	11002	Offline failed because the interface is not currently online.
LIF_OFFLINE_DISCARDED	11013	Internal error occurred and the operation was discarded. This is usually a transient error.
LIF_OFFLINE_SERVICE_STOPPED	11014	Interface state cannot be changed while the FCP service is stopped.

Produces

application/json

Consumes

application/json

Since

1.0

PUT /webmapi/net/interfaces/fc/{id}/action/online

Online an offline SAN interface

Description

Online an offline SAN interface

HTTP Example

PUT /webmapi/net/interfaces/fc/{id}/action/online

Path Parameters:

idThe ID or name of the instance (required=true).

Output

Reports successful result in ResponseContentType

Errors

Reports errors in ResponseContentType<ErrorType>

Error Key	Error Code	Error Description
LIF_ONLINE_LIF_NOT_FOUND	11004	Interface not found.
LIF_ONLINE_LIF_NOT_OFFLINE	11005	Online failed because the interface is not currently offline.
LIF_ONLINE_DISCARDED	11015	Internal error occurred and the operation was discarded. This is usually a transient error.
LIF_ONLINE_SERVICE_STOPPED	11016	Interface state can't be changed while the FCP service is stopped.

Produces

application/json

Consumes

application/json

Since

1.0

GET /webmapi/net/services/dns

Show the network DNS server

Description

Show the network DNS server

HTTP Example

GET /webmapi/net/services/dns

Output

Reports successful result in ResponseContentType<ClusterDnsServerOutputType>

Errors

Reports errors in ResponseContentType<ErrorType>

Error Key	Error Code	Error Description
NETWORK_DNS_SERVER_SHOW_INTERNAL_ERROR	35008	Internal error occurred.
NETWORK_DNS_SERVER_SHOW_REQUEST_IN_PROGRESS	35009	Another request is in progress.
NETWORK_DNS_SERVER_SHOW_DNS_UNINITIALIZED	35010	Network DNS server not initialized.
NETWORK_DNS_SERVER_SHOW_SHELL_FAILURE	35011	Network operation failed.
NETWORK_DNS_SERVER_SHOW_NETWORK_SHUTDOWN	35012	Network shutdown in progress.

Produces

application/json

Since

1.0.1

PUT /webmapi/net/services/dns

Set the network DNS server

Description

Set the network DNS server

To clear DNS settings, pass all empty fields to input except for protocol.

HTTP Example

PUT /webmapi/net/services/dns

Input

Pass input arguments in ClusterDnsServerModifyInputType

Output

Reports successful result in ResponseContentType

Errors

Reports errors in ResponseContentType<ErrorType>

Error Key	Error Code	Error Description
NETWORK_DNS_SERVER_MODIFY_INTERNAL_ERROR	35013	Internal error occurred.
NETWORK_DNS_SERVER_MODIFY_REQUEST_IN_PROGRESS	35014	Another request is in progress.
NETWORK_DNS_SERVER_MODIFY_SHELL_FAILURE	35015	Network operation failed.
NETWORK_DNS_SERVER_MODIFY_NETWORK_SHUTDOWN	35016	Network shutdown in progress.
NETWORK_DNS_SERVER_MODIFY_NETWORK_IPV6_NOT_SUPPORTED	35017	IPV6 not supported.
NETWORK_DNS_SERVER_MODIFY_NUM_NETWORK_DNS_SERVERS	35018	Incorrect number of DNS servers.
NETWORK_DNS_SERVER_MODIFY_DUPLICATE_DNS_SERVERS	35019	Duplicate DNS servers.
NETWORK_DNS_SERVER_MODIFY_INVALID_DNS_SERVER_IP	35020	INVALID DNS server IP.

Produces

application/json

Consumes

application/json

Since

1.0.1