Skip to main content

GET – Network Protocol

This resource is used to obtain or modify the network services managed by a given manager.

Request

GET https://ip/redfish/v1/Managers/Self/NetworkProtocol
Content-Type: application/json

Response

The response of the request will be in JSON format. The properties are mentioned in the following tables.

Table 1. Network Protocol Properties

Name

Type

Read only

Description

(OData Attributes)  

Refer to OData Support

OemObject 

OEM Extension (Optional), Refer to Resource Complex Types

Id(M)

String

True

Refer to Resource Type Definitions

Name(M)

String

True

Description

String

True

HostName

String

True

The DNS Host Name of this manager, without any domain information.

FQDN

String

True

This is the fully qualified domain name for the manager obtained by DNS including the host name and top-level domain name.

HTTPS

Object

False

This object shall contain information for the HTTPS/SSL protocol settings for this manager.

Refer to Protocol Properties.

Name

Type

Read only

Default Value

ProtocolEnabled

Boolean

False

True

Port

Number

False

443

SNMP

Object

False

This object shall contain information for the SNMP protocol settings for this manager.

Name

Type

Read only

Default Value

ProtocolEnabled

Boolean

False

True

Port

Number

False

161

VirtualMedia

Object

False

This object shall contain information for the Virtual Media protocol settings for this manager.

This property is not patchable when Single Port App feature is enabled in AMI BMC.

VirtualMedia maps to cd-media in AMI BMC.

Refer to Protocol Properties.

Name

Type

Read only

Default Value

ProtocolEnabled

Boolean

False

True

Port

Number

False

443

Telnet (Not Supported)

Object

False

This object shall contain information for the Telnet protocol settings for this manager.

Refer to Protocol Properties.

Name

Type

Read only

Default Value

ProtocolEnabled

Boolean

False

True

Port

Number

False

23

SSDP

Object

False

This object shall contain information for the SSDP protocol settings for this manager.

Simple Service Discovery Protocol (SSDP) is for network discovery of devices supporting the Redfish service.

Refer to Protocol Properties.

Name

Type

Read only

Default Value

ProtocolEnabled

Boolean

False

False

Port

Number

False

1900

IPMI(Not Supported)

Object

False

This object shall contain information for the IPMI over LAN protocol settings for the manager.

Name

Type

Read only

Default Value

ProtocolEnabled

Boolean

False

True

Port

Number

False

623

SSH

Object

False

This object shall contain information for the SSH protocol settings for the manager.

Refer to Protocol Properties.

Name

Type

Read only

Default Value

ProtocolEnabled

Boolean

False

True

Port

Number

False

22

KVMIP

Object

False

This object shall contain information for the KVM-IP (Keyboard, Video, Mouse) protocol settings for the manager.

The Port field for this protocol is read only when single port app is enabled.

Refer to Protocol Properties.

Name

Type

Read only

Default Value

ProtocolEnabled

Boolean

False

True

Port

Number

False

443

Status

Object

True

Refer toResource Properties for Resource Oem.

Actions

Object

True

This object will contain the actions for this resource under Oem property if any.

NTP

Object

False

This object shall contain information for the NTP protocol settings for the manager.

Refer to Protocol Properties.

Name

Type

Read only

Default Value

ProtocolEnabled

Boolean

False

True

Port

Number

False

123

NTPServersArray

False

“pool.ntp.org”, ”time.nist.gov”
OEM

Object

 

Lenovo OEM for manager network

Table 2. Lenovo OEM for manager network

Name

Type

Read only

Description

DNS

Object

True

Show sublink for Lenovo OEM setting for DNS

IOL

Object

False

This object shall contain “status” for IPMI over LAN.

Name

Type

Read only

Description

status

String

True

Indicates if the Ipv4/Ipv6 IOL protocol is enabled or disabled.

PortForwarding

Object

True

Show sublink for Lenovo OEM setting for Portforwarding

Table 3. Protocol properties

Name

Type

Read only

Description

ProtocolEnabled

Boolean

False

Indicates if the protocol is enabled or disabled

Port

Number

False

  1. Indicates the port assigned for the protocol. Minimum Value:0.

  2. Value of the Port can take any value between 1 and 65535.