API Reference Guide v0.1 Reference Guide... · 2020. 4. 13. · 8 1 Introduction MegaRAC® SP-X is a powerful server management solution composed of firmware and software components

2

RESTful API Reference Guide

Version 1.0 Copyright Copyright © 2020 MITAC COMPUTING TECHNOLOGY CORPORATION. All rights reserved. No part of this manual may be reproduced or translated without prior written consent from MITAC COMPUTING TECHNOLOGY CORPORATION. Notice Information contained in this document is furnished by MITAC COMPUTING TECHNOLOGY CORPORATION and has been reviewed for accuracy and reliability prior to printing. MITAC assumes no liability whatsoever, and disclaims any express or implied warranty, relating to sale and/or use of TYAN® products including liability or warranties relating to fitness for a particular purpose or merchantability. MITAC retains the right to make changes to product descriptions and/or specifications at any time, without notice. In no event will MITAC be held liable for any direct or indirect, incidental or consequential damage, loss of use, loss of data or other malady resulting from errors or inaccuracies of information contained in this document. Document number: D2496-100

3

Contents 1 Introduction .............................................................................................................................................................. 8

2 API Reference ........................................................................................................................................................... 8

2.1 GET /api/logs/audit ............................................................................................................................................. 8

2.2 GET /api/logs/event ............................................................................................................................................ 9

2.3 DELETE /api/logs/event ................................................................................................................................... 12

2.4 POST /api/session ............................................................................................................................................. 12

2.5 DELETE /api/session ........................................................................................................................................ 13

2.6 GET /api/sensors ............................................................................................................................................... 14

2.7 GET /api/sensors/{id} ....................................................................................................................................... 16

2.8 GET /api/settings/active-directory-users ........................................................................................................... 19

2.9 PUT /api/settings/active-directory-users/{id} ................................................................................................... 20

2.10 DELETE /api/settings/active-directory-users/{id} ........................................................................................... 22

2.11 GET /api/settings/active-directory -settings ...................................................................................................... 22

2.12 PUT /api/settings/active-directory-settings ....................................................................................................... 23

2.13 GET /api/settings/date-time .............................................................................................................................. 26

2.14 PUT /api/settings/date-time .............................................................................................................................. 27

2.15 GET /api/settings/ldap-users ............................................................................................................................. 30

2.16 PUT /api/settings/ldap-users/{id} ..................................................................................................................... 32

2.17 DELETE /api/settings/ldap-users/{id} .............................................................................................................. 34

2.18 GET /api/settings/ldap-settings ......................................................................................................................... 34

2.19 PUT /api/settings/ldap-settings ......................................................................................................................... 36

2.20 GET /api/settings/log ........................................................................................................................................ 39

2.21 PUT /api/settings/log ........................................................................................................................................ 41

2.22 GET /api/settings/media/instance ...................................................................................................................... 43

2.23 PUT /api/ settings/media/instance ..................................................................................................................... 47

2.24 GET /api/settings/media/general ....................................................................................................................... 55

2.25 PUT /api/settings/media/general ....................................................................................................................... 58

2.26 GET /api/settings/media/remotesession ............................................................................................................ 64

2.27 PUT /api/settings/media/remotesession ............................................................................................................ 64

2.28 GET api/settings/media/local/images ............................................................................................................... 67

2.29 GET api/settings/media/local/configurations .................................................................................................... 68

2.30 GET api/settings/media/remote/images ............................................................................................................ 70

2.31 GET api/settings/media/remote/configurations ................................................................................................ 71

2.32 GET /api/settings/network-bond ....................................................................................................................... 74

4

2.33 PUT /api/settings/network-bond ....................................................................................................................... 75

2.34 GET /api/settings/network-link ......................................................................................................................... 77

2.35 PUT /api/settings/network-link/{id} ................................................................................................................. 80

2.36 GET /api/settings/network ................................................................................................................................ 82

2.37 PUT /api/settings/network/{id} ........................................................................................................................ 86

2.38 GET /api/settings/static-ipv6 ............................................................................................................................ 91

2.39 GET /api/settings/dns ........................................................................................................................................ 92

2.40 PUT /api/settings/dns ........................................................................................................................................ 95

2.41 GET /api/settings/dns/registration................................................................................................................... 100

2.42 POST /api/settings/dns/registration ................................................................................................................. 102

2.43 GET /api/settings/dns/domain-options ............................................................................................................ 104

2.44 GET /api/settings/dns/server-options .............................................................................................................. 105

2.45 POST /api/settings/dns/tsig-private-key ......................................................................................................... 106

2.46 GET /api/settings/pam-order ........................................................................................................................... 106

2.47 PUT /api/settings/pam-order ........................................................................................................................... 106

2.48 GET /api/settings/services .............................................................................................................................. 108

2.49 PUT /api/settings/services/{id} ....................................................................................................................... 111

2.50 GET /api/settings/smtp ................................................................................................................................... 116

2.51 PUT /api/settings/smtp/{id} ............................................................................................................................ 121

2.52 GET /api/ssl/certificate ................................................................................................................................... 129

2.53 GET /api/settings/video/remote-storage ......................................................................................................... 131

2.54 PUT /api/settings/video/remote-storage .......................................................................................................... 133

2.55 GET /api/settings/video/triggers ..................................................................................................................... 136

2.56 PUT /api/settings/video/triggers ..................................................................................................................... 138

2.57 GET /api/settings/users ................................................................................................................................... 143

2.58 PUT /api/settings/users/{id} ........................................................................................................................... 147

2.59 DELETE /api/settings/users/{id} .................................................................................................................... 157

2.60 POST /api/settings/user/ssh-key-upload/{id} ................................................................................................. 158

2.61 GET /api/logs/system ...................................................................................................................................... 158

2.62 GET /api/logs/video ........................................................................................................................................ 160

2.63 PUT /api/logs/video-log .................................................................................................................................. 161

2.64 DELETE /api/logs/video-log/delete ................................................................................................................ 162

2.65 PUT /api/maintenance/flash ............................................................................................................................ 162

2.66 POST /api/maintenance/firmware ................................................................................................................... 162

2.67 GET /api/maintenance/firmware/verification ................................................................................................. 163

2.68 PUT /api/maintenance/firmware/upgrade ....................................................................................................... 166

5

2.69 GET /api/maintenance/flash-progress ............................................................................................................. 167

2.70 POST /api/maintenance/reset .......................................................................................................................... 168

2.71 GET /api/maintenance/signed-image-key ....................................................................................................... 168

2.72 POST /api/maintenance/signed-image-key ..................................................................................................... 169

2.73 GET /api/maintenance/signed-image-key-validity ......................................................................................... 169

2.74 GET /api/maintenance/firmware/dual_image_config ..................................................................................... 170

2.75 PUT /api/maintenance/firmware/hpm/updatemode ........................................................................................ 171

2.76 PUT /api/maintenance/firmware/hpm/exitupdatemode .................................................................................. 172

2.77 PUT /api/maintenance/firmware/hpm/preparecomponents ............................................................................. 173

2.78 PUT /api/maintenance/firmware/hpm/flash .................................................................................................... 174

2.79 GET /api/maintenance/firmware/hpm/upgradestatus ...................................................................................... 175

2.80 PUT /api/maintenance/firmware/hpm/verifyimage......................................................................................... 175

2.81 GET /api/maintenance/firmware/hpm/verifyimagestatus ............................................................................... 176

2.82 GET /api/maintenance/firmware/hpm/componentversions ............................................................................. 177

2.83 PUT /api/maintenance/firmware/hpm/activatecomponents ............................................................................ 178

2.84 POST /api/maintenance/firmware/hpm/mmcfw ............................................................................................. 178

2.85 GET /api/configuration/project ....................................................................................................................... 179

2.86 GET /api/fru .................................................................................................................................................... 184

2.87 GET /api/kvm/token ....................................................................................................................................... 187

2.88 GET /api/maintenance/backup_config ............................................................................................................ 187

2.89 PUT /api/maintenance/backup_config ............................................................................................................ 188

2.90 GET api/maintenance/bmc_recovery .............................................................................................................. 189

2.91 PUT api/maintenance/bmc_recovery .............................................................................................................. 190

2.92 GET api/maintenance/download_config ......................................................................................................... 191

2.93 GET api/ maintenance/fwimage_location ....................................................................................................... 191

2.94 PUT api/ maintenance/fwimage_location ....................................................................................................... 192

2.95 PUT /api/maintenance/preserve ...................................................................................................................... 194

2.96 GET /api/maintenance/preserve ...................................................................................................................... 196

2.97 POST /api/maintenance/upload_restore .......................................................................................................... 198

2.98 GET api/maintenance/system_admin ............................................................................................................. 199

2.99 PUT api/maintenance/system_admin .............................................................................................................. 199

2.100 GET api/scripts ............................................................................................................................................... 201

2.101 POST api/scripts ............................................................................................................................................. 201

2.102 DELETE api/scripts/{id} ................................................................................................................................ 202

2.103 GET /api/settings/channels ............................................................................................................................. 202

2.104 GET /api/settings/firewall ............................................................................................................................... 203

6

2.105 POST /api/settings/firewall ............................................................................................................................. 204

2.106 GET /api/settings/firewall-ip-rule ................................................................................................................... 205

2.107 POST /api/settings/firewall-ip-rule ................................................................................................................. 206

2.108 DELETE /api/settings/firewall-ip-rule ............................................................................................................ 207

2.109 GET /api/settings/firewall-port-rules .............................................................................................................. 208

2.110 POST /api/settings/firewall-port-rules ............................................................................................................ 209

2.111 DELETE /api/settings/firewall-port-rules{{id}} ............................................................................................ 211

2.112 GET /api/settings/licenses ............................................................................................................................... 211

2.113 POST /api/settings/licenses ............................................................................................................................. 212

2.114 GET /api/settings/mouse ................................................................................................................................. 212

2.115 PUT /api/settings/mouse ................................................................................................................................. 213

2.116 GET /api/settings/ncsi/mode ........................................................................................................................... 213

2.117 PUT /api/settings/ncsi/mode ........................................................................................................................... 214

2.118 GET /api/settings/network-interfaces ............................................................................................................. 215

2.119 GET /api/settings/packages ............................................................................................................................. 215

2.120 GET /api/settings/pef/alert_policies ................................................................................................................ 216

2.121 PUT /api/settings/pef/alert_policies ................................................................................................................ 218

2.122 DELETE /api/settings/pef/alert_policies/{id} ................................................................................................ 221

2.123 GET /api/settings/pef/lan_destinations ........................................................................................................... 222

2.124 GET /api/settings/pef/event_filters ................................................................................................................. 223

2.125 PUT /api/settings/pef/event_filters/{id} ......................................................................................................... 228

2.126 DELETE /api/settings/pef/event_filters/{id} .................................................................................................. 234

2.127 GET /api/settings/pef/lan_destinations ........................................................................................................... 234

2.128 PUT /api/settings/pef/lan_destinations ........................................................................................................... 235

2.129 DELETE /api/settings/pef/lan_destinations /{id} ........................................................................................... 237

2.130 GET / api/settings/radius/general .................................................................................................................... 237

2.131 POST / api/settings/radius/general .................................................................................................................. 239

2.132 GET /api/settings/radius/advanced ................................................................................................................. 241

2.133 POST /api/settings/radius/advanced ............................................................................................................... 242

2.134 GET /api/settings/sensor-threshold ................................................................................................................. 243

2.135 PUT /api/settings/sensor-threshold ................................................................................................................. 244

2.136 GET api/settings/ssl/certificate-info ............................................................................................................... 246

2.137 PUT api/settings/ssl/certificate-info ................................................................................................................ 247

2.138 GET api/settings/ssl/certificate ....................................................................................................................... 248

2.139 POST /api/operations/ssl/certificate/generate ................................................................................................. 250

2.140 GET api/settings/video/sol-remote-storage ..................................................................................................... 252

7

2.141 POST api/settings/video/sol-remote-storage ................................................................................................... 253

2.142 GET api/settings/video/sol-triggers ................................................................................................................ 256

2.143 PUT api/settings/video/sol-triggers................................................................................................................. 259

2.144 GET api/configuration/runtime ....................................................................................................................... 262

2.145 GET api/chassis-status .................................................................................................................................... 263

2.146 GET api/firmware-info ................................................................................................................................... 263

2.147 GET api/maintenance/restore_defaults ........................................................................................................... 265

2.148 PUT api/maintenance/restore_defaults ........................................................................................................... 268

2.149 GET api/scripts ............................................................................................................................................... 272

2.150 POST /api/settings/ldap-certificates ................................................................................................................ 273

2.151 POST /api/settings/media/remote/start-media ................................................................................................ 273

2.152 POST /api/settings/media/remote/stop-media ................................................................................................. 274

2.153 POST /api/maintenance/upload_restore .......................................................................................................... 275

8

1 Introduction MegaRAC® SP-X is a powerful server management solution composed of firmware and software components based on industry standards like IPMI 2.0, Restful APIs, SMASH, Serial Over LAN (SOL) and key serviceability features like remote presence, CIM profiles and advanced automation.

HTTP methods being used in SPX stack:-

GET

POST

PUT

DELETE

A RESTful API explicitly takes advantage of HTTP methodologies defined by the RFC 2616 protocol. They use GET to retrieve a resource; PUT to change the state of or update a resource, which can be an object, file or block; POST to create that resource; and DELETE to remove it.

This document provides REST API list which are being used in MegaRAC SPX stack and the detailed explanation for the JSON request and response properties.

2 API Reference

2.1 GET /api/logs/audit

Description: Request audit logs list

Request: N/A

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

Property Property Type Description

id Number Audit Log ID

timestamp Number Unix time stamp of the record

host_name String Host name where audit log was generated

message String Information on the record

9

Example:

Response:

[

{

"id": 0,

"timestamp": 1490680746,

"hostname": "localhost",

"message": "spx_restservice: spx_restservice - - [1866 : 1866 INFO]https Login from IP:10.0.124.125 user:admin - "

}

]

2.2 GET /api/logs/event

Description: Request event log list

Request: N/A



id Number Event Log ID

record_type String SEL Record type as per IPMI spec v2.0 Table 32-

1

System event record OEM timestamped OEM non-timestamped

timestamp Number Unix time stamp of the record

system_software_type String System software type as per IPMI spec v2.0 Table

5-4

BIOS SMI Handler System Management Software OEM Remote Console software 1-7 Terminal Model Remote Console

Software

generator_type String IPMB_Slave (or) System_Software

10

channel_number Number Channel that event message was received over

ipmb_lun Number IPMB device LUN, if generator type is

IPMB_Slave

event_format_ipmi_version Number Specifies the IPMI format version 04 if IPMI v2.0

or 03 if IPMI v1.0

sensor_type String Sensor type that generated the event

sensor_number Number Number that identifies the sensor that generated

the event

sensor_name String Name of sensor that generated the event

event_direction String Says if the event is asserted or a deasserted type

event_reading_class String Event reading class based on IPMI v2.0 Table 42-

2

Threshold Discrete Digital Discrete

sensor_reading_value Number Reading that triggered the event

sensor_reading_value_type String Reading type can be

Unspecified Trigger reading OEM code Sensor specific event extension

triggered_value Number Threshold value that was crossed to trigger this

event

triggered_type String Trigger type can be

Unspecified Trigger threshold value OEM code Sensor specific event extension

11

event_description String A brief message about the event which will be one

among software specific list, sensor specific list or

general events list

advanced_event_description String Additional message about the event, if any

Example:

Response:

[

{

"id": 1,

"record_type": "system_event_record",

"timestamp" : 1411339702,

"system_software_type": "system_management_software",

"generator_type": "ipmb_slave_address",

"channel_number": 1,

"ipmb_lun": 0,

"event_format_ipmi_version": 4,

"sensor_type": "temperature",

"sensor_number": 1,

"sensor_name": "CPU_PROX_TEMP",

"event_direction": "asserted",

"event_reading_class": "discrete",

"sensor_reading_value": 192,

"sensor_reading_value_type": "unspecified",

"triggered_value": 0,

"triggered_type": "unspecified",

"event_description": "timestamp_clock_sync",

"advanced_event_description" : "no_system_memory"

}]

12

2.3 DELETE /api/logs/event

Description: Request server to delete all event logs

Request: N/A

Response: The response of the request will be an empty JSON.

Example:

Response:

{ }

2.4 POST /api/session

Description: To establish a web service session

Request:


username String Username to authenticate

password String Password to authenticate



ok Number Status of the operation

0 – Success

1 – Login Failure

2 – Could not connect to LDAP/AD server

privilege Number Privilege level

4 - Admin

3 - Operator

2 - User

extendedpriv Number Extended Privilege

racsession_id Number Unique ID for the current session

13

remote_addr String Client machine Address

server_name String This property provides the Server name of

the BMC

server_addr String This property provides the Server Address

of the BMC

HTTPSEnabled Boolean Secured Connection Status

1 – HTTPs support Enabled

0 – HTTPs support Disabled

CSRFToken String This property provide a unique

alphanumeric id for every Web UI

session.

Example:

Request:

username:admin

password:admin

Response:

{

"ok": 0,

"privilege": 4,

"extendedpriv": 259,

"racsession_id": 3,

"remote_addr": "10.0.3.4",

"server_name": "10.0.125.151",

"server_addr": "10.0.125.151",

"HTTPSEnabled": 1,

"CSRFToken": "dkJkp7ir"

}

2.5 DELETE /api/session

Description: To destroy a web service session

Request: N/A

14



ok Number 0 – Success

2.6 GET /api/sensors

Description: Retrieve details about all sensors

Request: N/A



id Number Sensor ID in collection

sensor_number Number Number that identifies sensor

name String This property provides the Sensor Name

owner_id Number This property provides the Owner ID of the sensor

owner_lun Number This property provides the LUN number of the

sensor

raw_reading Number This property provides the Sensor Raw Reading

value

reading String This property provides the Sensor Reading value

unit String This property provides the Sensor Reading Units

type String This property provides the Sensor Type

type_number Number This property provides the Sensor Type ID

sensor_state Number This property provides the Sensor current State

1 - Active

0 - Inactive

15

discrete_state Number This property provides the current discrete Sensor

state

1 - Active

0 - Inactive

lower_non_recoverable_thresh

old

Number This property provides the Lower non recoverable

threshold value of sensor

lower_critical_threshold Number This property provides the Lower critical threshold

value of sensor

lower_non_critical_threshold Number This property provides the Lower non critical


higher_non_critical_threshold Number This property provides the Upper non critical


higher_critical_threshold Number This property provides the Upper critical threshold

value of sensor

higher_non_recoverable_thres

hold

Number This property provides the Upper non recoverable

threshold value of the sensor

accessible Number This property provides access state of sensor

0 – non accessible

1 - accessible

Example:

Response

{

"id": 1,

"sensor_number": 1,

"name": "Temp_1",

"owner_id": 32,

"owner_lun": 0,

"raw_reading": 0.000000,

"type": "temperature",

16

"type_number": 1,

"reading": 0.000000,

"sensor_state": 1,

"discrete_state": 0,

"lower_non_recoverable_threshold": 5.000000,

"lower_critical_threshold": 9.000000,

"lower_non_critical_threshold": 20.000000,

"higher_non_critical_threshold": 37.000000,

"higher_critical_threshold": 48.000000,

"higher_non_recoverable_threshold": 60.000000,

"accessible": 213,

"unit": "deg_c"

}

2.7 GET /api/sensors/{id}

Description: Retrieve details about one sensor

Request: N/A



id Number Sensor ID in collection

sensor_number Number Number that identifies sensor

name String This property provides the Sensor

Name

owner_id Number This property provides the Owner ID of

the sensor

owner_lun Number This property provides the Logical Unit

Number of the sensor

raw_reading Number This property provides the Sensor Live

Reading value

17

reading String This property provides the Sensor

Reading value

unit String This property provides the Sensor

Reading Units

Example: Watts, Volts, degree C, RPM

type String This property provides the Sensor Type

Temperature Voltages Fan sensor etc

type_number Number This property provides the Sensor Type

ID for each sensor

sensor_state Number This property provides the Sensor

current State

1 - Active

0 - Inactive

discrete_state Number This property provides the current state

of discrete Sensor like watchdog,

chassis_intr, SEL_sensor

1 - Active

0 - Inactive

lower_non_recoverable_threshold Number This property provides the Lower non

recoverable threshold value of sensor

lower_critical_threshold Number This property provides the Lower

critical threshold value of sensor

lower_non_critical_threshold Number This property provides the Lower non


higher_non_critical_threshold Number This property provides the Upper non


18

higher_critical_threshold Number This property provides the Upper


higher_non_recoverable_threshold Number This property provides the Upper non

recoverable threshold value of the

sensor

accessible Number This property provides access state of

sensor

0 – non accessible

1 - accessible

Example: Response:

{

"id": 1,

"sensor_number": 1,

"name": "Temp_1",

"owner_id": 32,

"owner_lun": 0,

"raw_reading": 0.000000,

"type": "temperature",

"type_number": 1,

"reading": 0.000000,

"sensor_state": 1,

"discrete_state": 0,






"higher_non_recoverable_threshold": 60.000000,

"accessible": 213,

"unit": "deg_c"

}

19

2.8 GET /api/settings/active-directory-users

Description: To retrieve all active directory user group

Request: N/A

Response: The response of the request will be in JSON format. The properties are mentioned in the following table


id Number Identifier of the user record

role_group_name String This name identifies the role group in Active

Directory.

role_group_domain String This is the domain where the role group is

located.

role_group_privilege String Privilege for the group.

Administrator User Operator OEM

role_group_kvm_privilege Boolean This property provides access to KVM for

AD authenticated role group user.

role_group_vmedia_privilege Boolean This property provides access to VMedia for


role_group_withoem_privile

ge

String This property provides access to OEM for

AD authenticated role group user

Example:

Response:

[

{

"id": 1,

"role_group_name": "unixusers1",

"role_group_domain": "megaracami.com",

"role_group_privilege": "administrator",

"role_group_kvm_privilege": 1,

20

"role_group_vmedia_privilege": 0,

"role_group_withoem_privilege": 0

}

]

2.9 PUT /api/settings/active-directory-users/{id}

Description: Modify existing group identified by the id

Request:




Directory.


located.







role_group_withoem_privilege String This property provides access to OEM for AD

authenticated role group user




21


Directory.


located.







role_group_withoem_privilege String This property provides access to OEM for

AD authenticated role group user

Example:

Request:

{

}

"id": 1,

"role_group_name": "TES",

"role_group_domain": "TEST.COM",

"role_group_privilege": "none",


"role_group_vmedia_privilege": 1

22

Response:

{

"id": 1,

"role_group_name": "TES",

"role_group_domain": "TEST.COM",




}

2.10 DELETE /api/settings/active-directory-users/{id}

Description: Delete one or all groups in AD

Request: N/A



cc Number Status of the operation

Example:

Response: { "cc": 0 }

2.11 GET /api/settings/active-directory -settings

Description: Retrieve general active directory settings

Request: N/A



id Number AD Setting identifier

enable Boolean This property provides AD authentication

1 – Enable

0 – Disable

user_domain_name String This property Specify the Domain Name for

the user

23

secret_username String This property Specify the Username of the

Active Directory Server.

domain_controller1 String Domain server IP/hostname 1



Example:

Response:

{

"enable": 1,

"id": 1,

"user_domain_name": "[email protected]",

"secret_username": "test",

"domain_controller1": "10.0.124.25",

"domain_controller2": "",


"secret_password": "test@123"

}

2.12 PUT /api/settings/active-directory-settings

Description: To Modify AD settings

Request:




1– Enable

0 – Disable

user_domain_name String This property Specify the Domain Name for

the user

24

secret_username String This property Specify the Username of the





secret_password String This property Specify the Secret Password for

the AD user

25





1 – Enable

0 – Disable

domain_name String This property Specify the Domain Name for

the user

secret_user String This property Specify the Username of the


domain_servers Array of Strings Array of Domain server IP/hostname

Example:

Request:

{

}

"enable": 1,

"id": 1,







26

Response:

{

"enable": 1,

"id": 1,







}

2.13 GET /api/settings/date-time

Description: Retrieve current date and time settings

Request: N/A



id Number Date & Time setting identifier

primary_ntp String This property is used to configure a primary NTP

server to use when automatically setting the date

and time.

secondary_ntp String This property is used to configure a secondary

NTP server to use when automatically setting the

date and time.

auto_date Boolean This property use the NTP servers to

automatically set the date and time.

1 - Enable

0 - Disable

localized_timestamp Number This property specifies the Localized timestamp

value

27

utc_minutes Number This property specifies the Difference in

timezone from Coordinated Universal Time

(UTC)

timestamp Number This property specifies the Unix timestamp of

current date and time

timezone String This property specifies the Timezone value

Example:

Response:

{

"id": 1,

"primary_ntp": "pool.ntp.org",

"secondary_ntp": "time.nist.gov",

"auto_date": 1,

"localized_timestamp": 1515387506,

"utc_minutes": -300,

"timestamp": 1515405506,

"timezone": "America/New_York"

}

2.14 PUT /api/settings/date-time

Description: Modify date and time settings

Request:







(UTC)

timezone String This property specifies the Timezone string

28

primary_ntp String This property is used to configure a primary

NTP server to use when automatically setting

the date and time.



the date and time.

29

auto_date Number This property use the NTP servers to


1 - Enable

0 - Disable


value








(UTC)

timezone String This property specifies the Timezone string

primary_ntp String This property is used to configure a primary


the date and time.



the date and time.

auto_date Number This property use the NTP servers to


1 - Enable

0 - Disable

30


value

Example:

Request:

{

}

"id": 1,



"auto_date": 0,



"timestamp": 1515407166,


Response:

{

"id": 1,



"auto_date": 0,



"timestamp": 1515407166,


}

2.15 GET /api/settings/ldap-users

Description: Retrieve all ldap user groups

Request: N/A Response: The response of the request will be in JSON format. The properties are mentioned in the following



31

role_group_name String This property specifies the Name for the group


located.

role_group_privilege String This is the level of privilege to be assigned for

the role group.

Administrator User Operator OEM None

role_group_withoem_privilege String This property provides access to OEM for LDAP

authenticated role group user.

role_group_kvm_privilege Boolean This property provides access to KVM for LDAP


1 - Enabled

0 - Disabled

role_group_vmedia_privilege Boolean This property provides access to VMEDIA for

LDAP authenticated role group user

1 - Enabled

0 - Disabled

Example:

Response:

[

{

"id": 1,

"role_group_name": "testname",

"role_group_domain": "dc=test",


"role_group_withoem_privilege": "none",



},

32

{

"id": 2,

"role_group_name": "test1",

"role_group_domain": "dc=domain2",


"role_group_withoem_privilege": "none",



}..

]

2.16 PUT /api/settings/ldap-users/{id}

Description: Modify existing group identified by the id

Request:





located.

role_group_privilege String This is the level of privilege to be assigned for

the role group.






1 - Enabled

33

0 - Disabled



1 - Enabled

0 - Disabled






located.



role_group_privilege String This is the level of privilege to be assigned for the

role group.




1 - Enabled

0 - Disabled



1 - Enabled

0 - Disabled

34

Example:

Request:

{

}

"id": 1,




"role_group_withoem_privilege": "user",



Response:

{

"id": 1,




"role_group_withoem_privilege": "user",



}

2.17 DELETE /api/settings/ldap-users/{id}

Description: Delete one or all groups in AD

Request: N/A




2.18 GET /api/settings/ldap-settings

Description: Retrieve general LDAP settings

Request: N/A Response: The response of the request will be in JSON format. The properties are mentioned in the following

35


id Number LDAP settings identifier

enable Boolean Property to Enable/Disable LDAP Authentication

1 – Enable

0 – Disable

encryption_type Boolean This property specifies the Encryption Types. They

are

No Encryption SSL StartTLS

port Number Specify the LDAP/E-Directory Port.

Default Port is 389. For SSL connections, default port is 636. Port value ranges from 1 to 65535.

server_address String LDAP/E-Directory Server Address will support the

following:

IPv4 Address format. IPv6 Address format.

NOTE: Configure FQDN address, when using

StartTLS with FQDN.

bind_dn String The Bind DN is used in bind operation, which

authenticates the client to the server.

Bind DN is a string of 4 to 64 alpha- numeric characters.

search_base String The Search base tells the LDAP/E-Directory server

which part of the external directory tree to search.

The search base may be something equivalent to the

organization, group of external directory.

Searchbase is a string of 4 to 64 alpha- numeric characters.

36

user_login_attribute String The attribute of user login field tells the LDAP/E-

Directory server which attribute should be used to

identify the user.

Only support cn or uid

common_name_type String Specifies the Common name type

FQDN IP Address

Example:

Response:

{

"enable": 1,

"id": 1,

"encryption_type": "2",

"port": "389",

"server_address": "10.0.125.52",

"bind_dn": "cn=admin",

"search_base": "ou=login",

"user_login_attribute": "cn",

"common_name_type": "fqdn",

"password": "test@1234"

}

2.19 PUT /api/settings/ldap-settings

Description: Modify general LDAP settings

Request:




1 – Enable

0 – Disable

37

encryption_type Boolean This property specifies the Encryption Types. They

are



Default Port is 389. For SSL connections, default port is 636. Port value ranges from 1 to 65535.

server_address String LDAP/E-Directory Server Address will support the

following:


NOTE: Configure FQDN address, when using

StartTLS with FQDN.

bind_dn String The Bind DN is used in bind operation, which

authenticates the client to the server.

Bind DN is a string of 4 to 64 alpha- numeric characters.

search_base String The Search base tells the LDAP/E-Directory server

which part of the external directory tree to search.

The search base may be something equivalent to the

organization, group of external directory.

Searchbase is a string of 4 to 64 alpha- numeric characters.

user_login_attribute String The attribute of user login field tells the LDAP/E-

Directory server which attribute should be used to

identify the user.



FQDN IP Address

38





1 – Enable

0 – Disable

encryption_type Boolean This property specifies the Encryption Types. They are



Default Port is 389.

For SSL connections, default port is 636.

Port value ranges from 1 to 65535.

server_address String LDAP/E-Directory Server Address will support the following:


NOTE: Configure FQDN address, when using StartTLS with FQDN.

bind_dn String The Bind DN is used in bind operation, which authenticates the client to the server.

Bind DN is a string of 4 to 64 alpha-numeric characters.

search_base String The Search base tells the LDAP/E-Directory server which part of the external directory tree to search. The search base may be something equivalent to the organization, group of external directory.

Searchbase is a string of 4 to 64 alpha-numeric characters.

user_login_attribute String The attribute of user login field tells the LDAP/E- Directory server which attribute should be used to identify the user.



FQDN

39

IP Address

Example:

Request:

{

}

"enable": 1,

"id": 1,


"port": "389",







Response:

{

"enable": 1,

"id": 1,


"port": "389",







}

2.20 GET /api/settings/log

Description: Retrieve log settings

Request: N/A



40

id Number Log settings identifier

audit_log Boolean Property to Enable audit log to view all audit events

for the device.

system_log Boolean Property to Enable System Log to view all system

events. Entries can be filtered based on their

classification levels.

file_size Number If Local log is selected, specify the size of the file in

bytes.

Size ranges from 3 to 65535.

rotate_count Number This property provides the rotate count. When

logged information exceeds the specified file size,

the old log information automatically gets moved to

back up files based on the rotate count value.

If the rotate count is zero, the old log information

gets cleared permanently each time.

server_addr String This property specify the remote server address to

log system events. Server address support the

following:

IP Address (Both IPv4 and IPv6 format). FQDN (Fully qualified domain name)

format

port Number Specify the port number to log system events.

Remote Number This property provides the log location

1 – Local Log

2 – Remote Log

Example:

Response:

{

"id": 1,

"audit_log": 1,

41

"system_log": 1,

"file_size": 50000,

"rotate_count": 0,

"port": 0,

"server_addr": "",

"remote": 1

}

2.21 PUT /api/settings/log

Description: Modify log settings

Request:



audit_log Boolean Property to Enable audit log to view all audit

events for the device.




file_size Number If Local log is selected, specify the size of the file

in bytes.




the old log information automatically gets moved

to back up files based on the rotate count value.





following:

42

IP Address (Both IPv4 and IPv6 format).

FQDN (Fully qualified domain name) format



1 – Local Log

2 – Remote Log




audit_log Boolean Property to Enable audit log to view all audit

events for the device.




file_size Number If Local log is selected, specify the size of the file

in bytes.




the old log information automatically gets moved

to back up files based on the rotate count value.





following:


43

FQDN (Fully qualified domain name) format



1 – Local Log

2 – Remote Log

Example:

Request:

{

}

"id": 1,

"audit_log": 1,

"system_log": 1,

"file_size": 50000,

"rotate_count": 0,

"port": 0,

"server_addr": "10.0.124.25",

"remote": "2"

Response:

{

"id": 1,

"audit_log": 1,

"system_log": 1,

"file_size": 50000,

"rotate_count": 0,

"port": 0,

"server_addr": "10.0.124.25",

"remote": "2"

}

2.22 GET /api/settings/media/instance

Description: Retrieve media redirection instance options

Request: N/A


44


id Number ID

secure_channel Boolean Enable Secure Channel for JViewer

num_fd Number This property provides the number of floppy

devices that are to be supported for Virtual Media

redirection.

The value ranges from “0” to “4”

num_cd Number This property provides the number of CD/DVD


redirection


num_hd Number This property provides the number of Hard disk

devices to be supported for Virtual Media

redirection.


kvm_num_fd Number This property provides the number of Remote

KVM floppy devices that are to be supported for

Virtual Media redirection.


kvm_num_cd Number This property provides the number of Remote

KVM CD/DVD devices that are to be supported for



kvm_num_hd Number This property provides the number of Remote

KVM Hard disk devices to be supported for Virtual

Media redirection.


45

sd_media Boolean This property provides access to emulate SD Media

on BMC as a USB device to Host Server

license Boolean License

cd_status Boolean This property provide status of CD media

redirection

0- Disabled

1- Enabled

cd_max_sessions Number Specify the max sessions allowed for CD image

redirection

cd_active_sessions Number This property provides the number of CD active

sessions

cd_port Number Specify the CD port number for Virtual Media

redirection.

cd_secure_port Number Specify the CD secure port number for Virtual

Media redirection.

fd_status Boolean This property provide status of FD media

redirection

0- Disabled

1- Enabled

fd_max_sessions Number Specify the max sessions allowed for FD image

redirection

fd_active_sessions Number This property provides the number of CD active

sessions

fd_port Number Specify the FD port number for Virtual Media

redirection.

46

fd_secure_port Number Specify the FD secure port number for Virtual

Media redirection.

hd_status Boolean This property provide status of HD media

redirection

0- Disabled

1- Enabled

hd_max_sessions Number Specify the max sessions allowed for HD image

redirection

hd_active_sessions Number This property provides the number of HD active

sessions

hd_port Number Specify the HD port number for Virtual Media

redirection.

hd_secure_port Number Specify the HD secure port number for Virtual

Media redirection.

single_port_enabled Number This property provides the single port status

0-Disabled

1-Enabled

power_save_mode Boolean This property provides access to Enable Power

Saving Mode

oemFeature Number This property OEM feature Enabled Status

0 – Disabled

1 – Enabled

Example:

Response:

{

"id": 1,

"license": 1,

47

"cd_status": 1,

"cd_max_sessions": 132,

"cd_active_sessions": 128,

"cd_port": -2147478528,

"cd_secure_port": -2147478524,

"fd_status": 1,

"fd_max_sessions": 132,

"fd_active_sessions": 128,

"fd_port": -2147478526,

"fd_secure_port": -2147478522,

"hd_status": 1,

"hd_max_sessions": 132,

"hd_active_sessions": 128,

"hd_port": -2147478525,

"hd_secure_port": -2147478521,

"secure_channel": 0,

"num_fd": 4,

"num_cd": 4,

"num_hd": 4,

"kvm_num_fd": 2,

"kvm_num_cd": 2,

"kvm_num_hd": 2,

"sd_media": 1,

"single_port_enabled": 1,

"power_save_mode": 1,

"oemFeature": 251

}

2.23 PUT /api/ settings/media/instance

Description: Set media redirection instance options

Request:


id Number ID

48




redirection.




redirection..




redirection.












Media redirection.




49



redirection

0- Disabled

1- Enabled


redirection


sessions


redirection.


Media redirection.


redirection

0- Disabled

1- Enabled


redirection


sessions


redirection.


Media redirection.

50


redirection

0- Disabled

1- Enabled


redirection


sessions


redirection.


Media redirection.


0-Disabled

1-Enabled


Saving Mode


0 – Disabled

1 – Enabled



id Number ID


51



redirection.




redirection..




redirection.












Media redirection.





52


redirection

0- Disabled

1- Enabled


redirection


sessions


redirection.


Media redirection.


redirection

0- Disabled

1- Enabled


redirection


sessions


redirection.


Media redirection.


redirection

53

0- Disabled

1- Enabled


redirection


sessions


redirection.


Media redirection.


0-Disabled

1-Enabled


Saving Mode


0 – Disabled

1 – Enabled

Example:

Request:

{

"id": 1,

"license": 1,

"cd_status": 1,



"cd_port": -2147478528,


"fd_status": 1,

54



"fd_port": -2147478526,


"hd_status": 1,



"hd_port": -2147478525,



"num_fd": 4,

"num_cd": 4,

"num_hd": 4,

"kvm_num_fd": 2,

"kvm_num_cd": 2,

"kvm_num_hd": 2,

"sd_media": 1,



"oemFeature": 251

}

Response:

{

"id": 1,

"license": 1,

"cd_status": 1,



"cd_port": -2147478528,


"fd_status": 1,



"fd_port": -2147478526,


"hd_status": 1,

55



"hd_port": -2147478525,



"num_fd": 4,

"num_cd": 4,

"num_hd": 4,

"kvm_num_fd": 2,

"kvm_num_cd": 2,

"kvm_num_hd": 2,

"sd_media": 1,



"oemFeature": 251

}

2.24 GET /api/settings/media/general

Description: Set general media redirection options

Request: N/A



id Number Identifier of the record

local_media_support Boolean This property is to enable or disable Local Media

support

0–Disable

1-Enable

remote_media_support Boolean This property is to enable or disable remote Media

support

0–Disable

1-Enabless

56

same_settings Boolean Property to enable or disable same setting option.

If Same settings for Floppy/Harddisk Images

option is selected, then the entered CD/DVD

media type data configurations will be same for

Floppy and Harddisk remote media types.

cd_remote_server_address String This property specifies the IP address of the server

where the CD remote media images are stored.

cd_remote_source_path String This property specifies the Source path to the

remote media images.

cd_remote_share_type String This property specifies the Share Type of the

remote media server either NFS or Samba(CIFS).

cd_remote_domain_name String This property provides the CD remote domain

name. Domain Name field is optional.

cd_remote_user_name String If share Type is Samba(CIFS), then enter user

credentials to authenticate on the server.

mount_cd Boolean This property is used to mount cd drive

0-Mount

1-unmount

mount_fd Boolean This property is used to mount fd

0-Mount

1-unmount

mount_hd Boolean This property is used to mount hd

0-Mount

1-unmount

fd_remote_server_address String This property specifies the IP address of the server

where the FD remote media images are stored.

57

fd_remote_source_path String This property specifies the Source path to the


fd_remote_share_type String This property specifies the Share Type of the


fd_remote_domain_name String This property provides the FD remote domain


fd_remote_user_name String If share Type is Samba(CIFS), then enter user


hd_remote_server_address String This property specifies the IP address of the server

where the CD remote media images are stored.

hd_remote_source_path String This property specifies the Source path to the


hd_remote_share_type String This property specifies the Share Type of the


hd_remote_domain_name String This property provides the HD remote domain


hd_remote_user_name String If share Type is Samba(CIFS), then enter user


Example:

Response:

{

"cd_remote_domain_name": "megarac",

"cd_remote_password": "admin",

"cd_remote_server_address": "10.0.124.25",

"cd_remote_share_type": "cifs",

"cd_remote_source_path": "/home/images",

"cd_remote_user_name": "admin",

"fd_remote_domain_name": "",

"fd_remote_password": "",

58

"fd_remote_server_address": "",

"fd_remote_share_type": "",

"fd_remote_source_path": "",

"fd_remote_user_name": "",

"hd_remote_domain_name": "",

"hd_remote_password": "",

"hd_remote_server_address": "",

"hd_remote_share_type": "",

"hd_remote_source_path": "",

"hd_remote_user_name": "",

"id": 1,

"local_media_support": 1,

"mount_cd": 1,

"mount_fd": 0,

"mount_hd": 0,

"remote_media_support": 1,

"same_settings": 1

}

2.25 PUT /api/settings/media/general

Description: Set general media redirection options

Request:


id Number Identifier of the record

local_media_support Boolean This property is to enable or disable Local

Media support

0–Disable

1-Enable

remote_media_support Boolean This property is to enable or disable remote

Media support

0–Disable

59

1-Enabless

same_settings Boolean Property to enable or disable same setting

option.





cd_remote_server_address String This property specifies the IP address of the

server where the CD remote media images are

stored.




remote media server either NFS or

Samba(CIFS).






0-Mount

1-unmount


0-Mount

1-unmount


0-Mount

60

1-unmount

fd_remote_server_address String This property specifies the IP address of the

server where the FD remote media images are

stored.





Samba(CIFS).





hd_remote_server_address String This property specifies the IP address of the


stored.





Samba(CIFS).







61

id Number ID

local_media_support Boolean This property is to enable or disable Local

Media support

0–Disable

1-Enable

remote_media_support Boolean This property is to enable or disable remote

Media support

0–Disable

1-Enabless

same_settings Boolean Property to enable or disable same setting

option.





cd_remote_server_address String This property specifies the IP address of the


stored.





Samba(CIFS).





62


0-Unmount

1-Mount


0-Unmount

1-Mount


0-Unmount

1-Mount

fd_remote_server_address String This property specifies the IP address of the

server where the FD remote media images are

stored.





Samba(CIFS).





hd_remote_server_address String This property specifies the IP address of the


stored.



63



Samba(CIFS).





Example:

Request:

{



















"id": 1,


"mount_cd": 1,

"mount_fd": 0,

"mount_hd": 0,

64


"same_settings": 1

}

Response:

{



















"id": 1,


"mount_cd": 1,

"mount_fd": 0,

"mount_hd": 0,


"same_settings": 1

}

2.26 GET /api/settings/media/remotesession

Description: Get remote session media redirection options

Request: N/A


63


id Number Remote Session settings identifier

single_port Boolean This property provides Single Port Application

support in BMC when using H5Viewer.

kvm_encryption Boolean This property is to Encrypt H5Viewer KVM

packets

keyboard_language String Keyboad Language

local_media_enable Boolean Local Media Mode

1 – Enabled

0 – Disabled

remote_media_enable Boolean Remote Media Mode

1 – Enabled

0 – Disabled

vmedia_attach Number Virtual media attach mode

retry_count Number Number of times to be retried in case of KVM

failure; Ranges from 1 to 6.

retry_time_interval Number Number of seconds to wait for subsequent

retries.Time interval ranges from 5 to 30 seconds.

local_monitor_off Boolean This property provides access to turn OFF local

monitor

automatic_off Boolean Enable Automatically OFF Local Monitor when

JViewer Launches

sd_card_status Boolean SD Card Status

1 – Enabled

0 – Disabled

64

Example:

Response:

{

"id": 1,

"single_port": 1,

"kvm_encryption": 0,

"keyboard_language": "AD",

"local_media_enable": 1,

"remote_media_enable": 0,

"vmedia_attach": 0,

"retry_count": 3,

"retry_time_interval": 10,

"local_monitor_off": 1,

"automatic_off": 0,

"sd_card_status": 0

}

2.27 PUT /api/settings/media/remotesession

Description: Set remote session media redirection options

Request:






packets



1 – Enabled

0 – Disabled

65


1 – Enabled

0 – Disabled




retry_time_interval Number Number of seconds to wait for subsequent retries.

Time interval ranges from 5 to 30 seconds.

local_monitor_off Boolean Enable local monitor off


JViewer Launches


1 – Enabled

0 – Disabled







packets



1 – Enabled

66

0 – Disabled


1 – Enabled

0 – Disabled




retry_time_interval Number Number of seconds to wait for subsequent retries.

Time interval ranges from 5 to 30 seconds.

local_monitor_off Boolean Enable local monitor off


JViewer Launches


1 – Enabled

0 – Disabled

Example:

Request:

{

"id": 1,

"single_port": 1,





"vmedia_attach": 0,

"retry_count": "3",

"retry_time_interval": "10",


"automatic_off": 1,

67

"sd_card_status": 0

}

Response:

{

"id": 1,

"single_port": 1,





"vmedia_attach": 0,

"retry_count": "3",

"retry_time_interval": "10",


"automatic_off": 1,

"sd_card_status": 0

}

2.28 GET api/settings/media/local/images

Description: To Retrieve local images

Request: N/A




image_type Number This property provides the image type

Img Nrg Iso

image_index Number This property provides the index value of each

image type.

image_name String This property provides the image name

Example:

68

[

{

"id": 1,

"image_type": 8,

"image_index": 0,

"image_name": "efiboot.img"

},

{

"id": 2,

"image_type": 8,

"image_index": 1,

"image_name": "Boot-CD.nrg"

}

]

2.29 GET api/settings/media/local/configurations

Description: To Retrive local images configuration

Request: N/A




media_type Number This property provides the media type

CD/DVD Floppy Disk Hard Disk

media_index Number This property provides the index value of each

media.

session_index Number This property provides the connected server

session index value


redirection_status Number This provides the redirection status

69

0 – No redirection

1 – Redirection is in progress

Example:

[

{

"id": 1,

"media_type": 1,

"media_index": 0,

"session_index": 255,

"image_name": "",

"redirection_status": 0

},

{

"id": 2,

"media_type": 1,

"media_index": 1,


"image_name": "",


},

{

"id": 3,

"media_type": 1,

"media_index": 2,


"image_name": "",


},

{

"id": 4,

"media_type": 1,

"media_index": 3,


"image_name": "",


70

}..

]

2.30 GET api/settings/media/remote/images

Description: To Retrieve remote images

Request: N/A


71



image_type Number This property provides the image type like

Img Nrg Iso

image_index Number This property provides the index value of each

image type.


Example:

[

{

"id": 1,

"image_type": 8,

"image_index": 0,

"image_name": "efiboot.img"

},

{

"id": 2,

"image_type": 8,

"image_index": 1,

"image_name": "Boot-CD.nrg"

}

]

2.31 GET api/settings/media/remote/configurations

Description: To Retrieve remote media configurations

Request: N/A



72


media_type Number This property provides the media type

CD/DVD Floppy Disk Hard Disk

media_index Number This property provides the index value of each

media.

session_index Number This property provides the connected server

session index value


redirection_status Number This provides the redirection status

0 – No redirection

1 – Redirection is in progress

Example:

[

{

"id": 1,

"media_type": 1,

"media_index": 0,

"session_index": 0,

"image_name": "cdiso2.iso",


},

{

"id": 2,

"media_type": 1,

"media_index": 1,


"image_name": "",


},

{

73

"id": 3,

"media_type": 1,

"media_index": 2,


"image_name": "",


},

{

"id": 4,

"media_type": 1,

"media_index": 3,


"image_name": "",


},

{

"id": 5,

"media_type": 4,

"media_index": 0,

"session_index": 0,

"image_name": "ef1.img",


},

{

"id": 6,

"media_type": 4,

"media_index": 1,

"session_index": 1,

"image_name": "efiboot.img",


},

{

"id": 7,

"media_type": 4,

"media_index": 2,


74

"image_name": "",


},

{

"id": 8,

"media_type": 4,

"media_index": 3,


"image_name": "",


}

]

2.32 GET /api/settings/network-bond

Description: Retrieve network bond settings

Request: N/A



id Number Network Bond Settings Identifier

bond_enable Boolean This property is used to enable network bonding for

network interfaces.

NOTE: If VLAN is enabled for slave interfaces,

then Bonding cannot be enabled.

1 - Enable

0 - Disable

bond_mode Number Network Bonding Mode

0 – Balance Round Robin

1 – Active Backup

2 – Balance XOR

3 – Broadcast

75

4 – 802.3ad

5 – Balance TLB

6 – Balance ALB

bond_ifc String NIC which is in bond

auto_configuration_enable Boolean Enable this property to configure the interfaces

automatically.

NOTE: If Auto configuration is disabled, then

interfaces in services can be configured via IPMI

command. If Auto configuration is enabled, then all

the services will be restarted automatically.

Example:

Response:

{

"id": 1,

"bond_enable": 1,

"bond_mode": "active-backup",

"bond_ifc": "eth1",

"auto_configuration_enable": 1

}

2.33 PUT /api/settings/network-bond

Description: Modify network bond settings

Request:



bond_enable Boolean This property is used to enable network bonding

for network interfaces.

NOTE: If VLAN is enabled for slave interfaces,

then Bonding cannot be enabled.

1 - Enable

76

0 - Disable



1 – Active Backup

2 – Balance XOR

3 – Broadcast

4 – 802.3ad

5 – Balance TLB

6 – Balance ALB



automatically.

NOTE: If Auto configuration is disabled, then

interfaces in services can be configured via IPMI

command. If Auto configuration is enabled, then

all the services will be restarted automatically.




bond_enable Boolean This property is used to enable network bonding

for network interfaces. NOTE: If VLAN is

enabled for slave interfaces, then Bonding cannot

be enabled.

1 - Enable

0 - Disable


77


1 – Active Backup

2 – Balance XOR

3 – Broadcast

4 – 802.3ad

5 – Balance TLB

6 – Balance ALB



automatically.

Example:

Request:

{

}

"id": 1,

"bond_enable": 0,


"bond_ifc": "eth1",


Response:

{

"id": 1,

"bond_enable": 0,


"bond_ifc": "eth1",


}

2.34 GET /api/settings/network-link

Description: Retrieve network link settings of all networks

Request: N/A

78


79


id Number Network Link Settings Identifier

interface_name String This property provides the Interface name for

which the Link speed and duplex mode are to be

configured.

Eth0 /Eth1 (or) Bond0

auto_negotiation Boolean This property is enabled to allow the device to

perform automatic configuration to achieve the

best possible mode of operation (speed and

duplex) over a link.

1 - Enable

0 - Disable

link_speed_auto_negotiated Number Link Speed

link_speed Number Link speed will list all the supported capabilities

of the network interface. It can be 10/100/1000

Mbps.

NOTE: Link speed of 1000 Mbps is not

applicable, when Auto Negotiation is OFF.

duplex_mode_auto_negotiated String Duplex mode

duplex_mode String Duplex mode

Half Duplex Full Duplex

Example:

Response:

[

{

"id": 1,

"auto_negotiation": 1,

"link_speed_auto_negotiated": 10,

80

"link_speed": 10,

"interface_name": "eth0",

"duplex_mode_auto_negotiated": "HALF",

"duplex_mode": "HALF"

},

{

"id": 2,



"link_speed": 100,


"duplex_mode_auto_negotiated": "FULL",

"duplex_mode": "FULL"

}

]

2.35 PUT /api/settings/network-link/{id}

Description: Modify network link settings

Request:





configured.






1 - Enable

0 - Disable

81




Mbps. Note: Link speed of 1000 Mbps is not










configured.






1 - Enable

0 - Disable




Mbps.

82

NOTE: Link speed of 1000 Mbps is not





Example:

Request:

{

}

"id": 1,



"link_speed": 10,




Response:

{

"id": 1,



"link_speed": 10,




}

2.36 GET /api/settings/network

Description: Retrieve all network details

Request: N/A

83



id Number Network Settings Identifier

interface_name String Name of the interface


channel_number Number NIC channel number

lan_enable Boolean This property is to enable LAN support

mac_address String This property provides the MAC address of the

selected interface (read only).

ipv4_enable String This property is to enable IPv4 support for the

selected interface

1 - Enable

0 - Disable

ipv4_dhcp_enable Boolean This property is to enable IPv4 DHCP support for

the selected interface

1 - Enable

0 - Disable

ipv4_address String If DHCP is disabled, specify a static IPv4 address

to be configured for the selected interface.

ipv4_subnet String If DHCP is disabled, specify a static Subnet Mask


ipv4_gateway String If DHCP is disabled, specify a static Default

Gateway to be configured for the selected

interface.

84

ipv6_enable Boolean This property is to enable IPv6 support for the

selected interface

ipv6_dhcp_enable Boolean This property is to enable IPv6 DHCP to

dynamically configure IPv6 address using

Dynamic HostConfiguration v6 Protocol

(DHCPv6).

ipv6_address String IPv6 address

ipv6_index Number Ipv6 index range from 0 to 15

ipv6_prefix Number Specify the subnet prefix length for the IPv6

settings.

Value ranges from 0 to 128.



interface.

vlan_enable Boolean This property specifies the VLAN support for the

selected interface.

1 – Enabled

0 - Disabled

vlan_id Number This property specifies the VLAN identifier

vlan_priority Number This property specifies the VLAN Priority.

The value range from 0 to 7.

Example:

Response:

[

{

"id": 1,



"lan_enable": 1,

85

"mac_address": "00:12:12:12:12:12",

"ipv4_enable": 1,

"ipv4_dhcp_enable": 1,

"ipv4_address": "0.0.0.0",

"ipv4_subnet": "0.0.0.0",

"ipv4_gateway": "0.0.0.0",

"ipv6_enable": 1,


"ipv6_address": "::",

"ipv6_index": 0,

"ipv6_prefix": 0,

"ipv6_gateway": "::",

"vlan_enable": 0,

"vlan_id": 0,

"vlan_priority": 0

},

{

"id": 2,



"lan_enable": 1,

"mac_address": "00:22:12:22:11:11",

"ipv4_enable": 1,


"ipv4_address": "10.0.125.221",

"ipv4_subnet": "255.255.248.0",

"ipv4_gateway": "10.0.120.1",

"ipv6_enable": 1,


"ipv6_address": "3ffe:501:ffff:102:222:12ff:fe22:1111",

"ipv6_index": 0,

"ipv6_prefix": 64,


"vlan_enable": 0,

"vlan_id": 0,

"vlan_priority": 0

86

}

]

2.37 PUT /api/settings/network/{id}

Description: Modify network details

Request:










selected interface

1 - Enable

0 - Disable



1 - Enable

0 - Disable





87



interface.


selected interface




(DHCPv6).




settings.




interface.


selected interface.

1 – Enabled

0 - Disabled




88











selected interface

1 - Enable

0 - Disable



1 - Enable

0 - Disable







interface.

89


selected interface




(DHCPv6).




settings.




interface.


selected interface.

1 – Enabled

0 - Disabled




Example:

Request:

{

"id": 2,



"lan_enable": 1,

"mac_address": "00:22:12:22:11:11",

90

"ipv4_enable": 1,


"ipv4_address": "10.0.125.221",

"ipv4_subnet": "255.255.248.0",

"ipv4_gateway": "10.0.120.1",

"ipv6_enable": 1,



"ipv6_index": 0,

"ipv6_prefix": 64,


"vlan_enable": 0,

"vlan_id": 0,

"vlan_priority": 0

}

Response:

{

"id": 2,



"lan_enable": 1,

"mac_address": "00:22:12:22:11:11",

"ipv4_enable": 1,


"ipv4_address": "10.0.125.221",

"ipv4_subnet": "255.255.248.0",

"ipv4_gateway": "10.0.120.1",

"ipv6_enable": 1,



"ipv6_index": 0,

"ipv6_prefix": 64,


"vlan_enable": 0,

"vlan_id": 0,

"vlan_priority": 0

91

}

2.38 GET /api/settings/static-ipv6

Description: Retrieve general DNS settings

Request: N/A





Eth0 /Eth1 / Both (or) Bond0

ipv6_address String This property specifies the IPv6 address


settings.


Example:

Response:

[

{

"ipv6_index": 0,


"ipv6_address": "",

"ipv6_prefix": 0

},

{

"ipv6_index": 1,


"ipv6_address": "",

"ipv6_prefix": 0

}..

]

92

2.39 GET /api/settings/dns


Request: N/A



reg_id Number DNS Identifier

reg_ifc1 String This property provides the BMC interface name

Eth0/Eth1/Bond0

reg_enable1 Boolean This property is used to enable or disable DNS

registration

reg_option1 Number This property provides the Registration method

Nsupdate (0)- Register with the DNS server using the nsupdate application

DHCP Client FQDN (1) - Register with the DNS server using DHCP option 81.

Hostname (2) - Register with the DNS server using DHCP option 12.

NOTE: Hostname option should be selected if the

DHCP server does not support option 81.

reg_mdns1 Boolean This property is to enable or disable multicast

DNS

reg_tsig1 Number This property is to enable or disable DNS

registration TSIG authentication while registering

DNS via nsupdate.


Eth0/Eth1/Bond0


registration


93

Nsupdate (0)- Register with the DNS server using the nsupdate application

DHCP Client FQDN (1) - Register with the DNS server using DHCP option 81.





DNS



DNS via nsupdate.

dns_server1 String This property Specify the DNS (Domain Name

System) server address to be configured for the

BMC.

IPv4 Addresses should be given in dotted decimal

representation.

IPv6 Addresses are supported and must be global

unicast addresses.

dns_server2 String This property is similar to dns_server1


id Number DNS Identifier

dns_status Boolean This property is to enable all DNS services

reg_count Number DNS registration count

ip_count Number DNS registration IP count

host_cfg Boolean The host name will be configured manually or

automatically.

Automatic (1) Manual (0)

94

host_name String This property provides the Current host name

tsig_private String This property provides the Current TSIG

(Transaction SIGnature) private key file

tsig_exists Boolean This property specify whether the TSIG

(Transaction SIGnature) key file exists or not

domain_manual Boolean This property provides whether the domain name

will be configured manually or automatically.


domain_iface String Current interface name in use

When bond is disabled

eth0_v6 eth1_v6 eth0_v4 eth1_v4

When bond is enabled

Bond0_v4 Bond0_v6

domain_name String Current domain name

dns_manual Boolean This property provides whether the DNS interface



dns_iface String Current interface name in use

Eth0 / Eth1

dns_priority Boolean Current DNS IP priority

Example:

Response:

{

"reg_id": 2,

"reg_ifc1": "eth0",

"reg_enable1": 1,

95

"reg_option1": 0,

"reg_mdns1": 0,

"reg_tsig1": 0,

"reg_ifc2": "eth1",

"reg_enable2": 0,

"reg_option2": 0,

"reg_mdns2": 0,

"reg_tsig2": 0,

"dns_server1": "10.0.0.31",

"dns_server2": "10.0.0.32",

"dns_server3": "::",

"id": 1,

"dns_status": 1,

"reg_count": 2,

"ip_count": 3,

"host_cfg": "1",

"host_name": "AMI001212121212",

"tsig_private": "Not Available",

"tsig_privstat": "",

"tsig_exists": 0,

"domain_manual": "1",

"domain_iface": "eth0_v4",

"domain_name": "in.megatrends.com",

"dns_manual": "1",

"dns_iface": "eth0",

"dns_priority": "6"

}

2.40 PUT /api/settings/dns


Request: N/A



reg_id Number DNS Identifier

96


Eth0/Eth1/Bond0


registration


Nsupdate - Register with the DNS server using the nsupdate application

DHCP Client FQDN - Register with the DNS server using DHCP option 81.

Hostname - Register with the DNS server using DHCP option 12.




DNS



DNS via nsupdate.


Eth0/Eth1/Bond0


registration


Nsupdate - Register with the DNS server using the nsupdate application

DHCP Client FQDN - Register with the DNS server using DHCP option 81.

Hostname - Register with the DNS server using DHCP option 12.



97


DNS



DNS via nsupdate.

dns_server1 String This property Specify the DNS (Domain Name

System) server address to be configured for the

BMC.

IPv4 Addresses should be given in dotted decimal

representation.

IPv6 Addresses are supported and must be global

unicast addresses.



id Number DNS Identifier

dns_status Boolean This property is to enable all DNS services

reg_count Number DNS registration count

ip_count Number DNS registration IP count

host_cfg Boolean The host name will be configured manually or

automatically.


host_name String This property provides the Current host name

tsig_private String This property provides the Current TSIG private

key file

98

tsig_exists Boolean This property specify whether theTSIG key file

exists or not

domain_manual Boolean This property provides whether the domain name







Bond0_v4 Bond0_v6

domain_name String Current domain name

dns_manual Boolean This property provides whether the DNS interface



dns_iface String Current interface name in use

Eth0 / Eth1

dns_priority Boolean Current DNS IP priority

Example:

Request:

{

"reg_id": 2,

"reg_ifc1": "eth0",

"reg_enable1": 1,

"reg_option1": 1,

"reg_mdns1": 0,

"reg_tsig1": 0,

"reg_ifc2": "eth1",

99

"reg_enable2": 1,

"reg_option2": 0,

"reg_mdns2": 0,

"reg_tsig2": 0,

"dns_server1": "10.0.0.31",

"dns_server2": "10.0.0.32",


"id": 1,

"dns_status": 1,

"reg_count": 2,

"ip_count": 3,

"host_cfg": "1",

"host_name": "AMI001212121212",



"tsig_exists": 0,


"domain_iface": null,


"dns_manual": "1",

"dns_iface": “eth0”,

"dns_priority": 0

}

Response:

{

"reg_id": 2,

"reg_ifc1": "eth0",

"reg_enable1": 1,

"reg_option1": 1,

"reg_mdns1": 0,

"reg_tsig1": 0,

"reg_ifc2": "eth1",

"reg_enable2": 1,

"reg_option2": 0,

"reg_mdns2": 0,

"reg_tsig2": 0,

100

"dns_server1": "10.0.0.31",

"dns_server2": "10.0.0.32",


"id": 1,

"dns_status": 1,

"reg_count": 2,

"ip_count": 3,

"host_cfg": "1",

"host_name": "AMI001212121212",



"tsig_exists": 0,


"domain_iface": null,


"dns_manual": "1",

"dns_iface": "eth0",,

"dns_priority": 0

}

2.41 GET /api/settings/dns/registration

Description: Retrieve DNS registration settings

Request: N/A



Id Number Identifier of the record

ethIndex Number Eth Index

Eth0 (0) Eth1 (1) Bond0 (2)

reg_ifc String This property specifies BMC Registration IFC

value

reg_enable Number This property is to enable all DNS services

101

1 - Enable 0 - Disable

reg_option Number This property provides the Registration method

Nsupdate (0) - Register with the DNS server using the nsupdate application

DHCP Client FQDN (1)- Register with the DNS server using DHCP option 81.




reg_mdns Boolean This property is to enable Multicast DNS

1 - Enable

0 - Disable

reg_tsig Boolean reg_tsig0 - This property provides access to

enable or disable Eth0 tsig authentication

reg_tsig1 - This property provides access to

enable or disable Eth1 tsig authentication

reg_tsig2 - This property provides access to

enable or disable Bond0 tsig authentication

Enable (1) Disable (0)

Example:

Response:

[

{

"id": 1,

"ethIndex": 0,

"reg_ifc": "eth0",

"reg_enable": 1,

"reg_option": 0,

"reg_mdns": 0,

"reg_tsig0": 0

},

{

102

"id": 2,

"ethIndex": 1,

"reg_ifc": "eth1",

"reg_enable": 0,

"reg_option": 0,

"reg_mdns": 0,

"reg_tsig1": 0

}

]

2.42 POST /api/settings/dns/registration

Description: Upload DNS registration settings

Request:


reg_enable String DNS Registration mode

Disable(0)

Enable(1)

The string provides DNS Registration mode of

Eth0, Eth1, Bond0 and Both (Eth0 & Eth1)

interfaces. Which are concatenated by comma

(E.g 1,1,0,0)

reg_option String This property provides the Registration method




NOTE: Hostname option should be selected if

the DHCP server does not support option 81.

The string provides Registration method of


103


(E.g 1,1,0,0)

reg_mdns Number This property is to enable or disable multicast

DNS registration

reg_tsig String This property provides access to enable or

disable tsig authentication

The string provides TSIG Authentication status

of Eth0, Eth1, Bond0 and Both (Eth0 & Eth1)


respectively. (E.g 1,1,0,0)

Enabled(1) Disabled(0)



reg_enable String DNS Registration mode

Disable(0)

Enable(1)

The string provides DNS Registration mode of Eth0, Eth1, Bond0 and Both (Eth0 & Eth1) interfaces. Which are concatenated by comma (E.g 1,1,0,0)

reg_option String This property provides the Registration method




NOTE: Hostname option should be selected if

the DHCP server does not support option 81.

The string provides Registration method of


104


(E.g 1,1,0,0)

reg_mdns Number This property is to enable or disable multicast

DNS registration

reg_tsig String This property provides access to enable or

disable tsig authentication

The string provides TSIG Authentication status

of Eth0, Eth1, Bond0 and Both (Eth0 & Eth1)


respectively. (E.g 1,1,0,0)

Enabled(1) Disabled(0)

Note: The response value of reg_enable, reg_tsig, reg_option would be in UTF characters, which will be converted into string in front end.

Example:

Request:

{

"reg_enable": "1,1,0,0",

"reg_option": "1,0,0,0",

"reg_mdns": 0,

"reg_tsig": “1,0,0,0”

}

Response:

{

"reg_enable": "1\u00001\u00000\u00000",

"reg_option": "1\u00000\u00000\u00000",

"reg_mdns": 0,

"reg_tsig": "1\u00000\u00000\u00000"”

}

2.43 GET /api/settings/dns/domain-options

Description: Retrieve DNS domain interface options

Request: N/A


105


id Number DNS Domain Interface Identifier





Bond0_v4 Bond0_v6

Example:

Response:

[ { "id": 1, "domain_iface": "eth0_v4" }, { "id": 2, "domain_iface": "eth0_v6" }, { "id": 3, "domain_iface": "eth1_v4" }, { "id": 4, "domain_iface": "eth1_v6" } ]

2.44 GET /api/settings/dns/server-options

Description: Retrieve DNS server interface options

Request: N/A



id Number DNS Server Interface Identifier

dns_iface String Available interface name

Eth0 Eth1

Example:

Response:

{

}

"id": 1,

"dns_iface": "eth0"

106

2.45 POST /api/settings/dns/tsig-private-key

Description: To Upload TSIG private key file while configuring the network DNS. TSIG (Transaction SIGnature) is a computer-networking protocol defined in RFC 2845. Primarily it enables the Domain Name System (DNS) to authenticate updates to a DNS database.

Request: File Upload



Cc Number Status of the operation

2.46 GET /api/settings/pam-order

Description: Retrieve PAM order settings

Request: N/A



id Number PAM settings identifier

pam_position Number Index of position in PAM order

pam_module_name String List the PAM module

Example:

Response:

[

{

"id": 1,

"pam_position": 1,

"pam_module_name": "IPMI"

},

{

"id": 2,

"pam_position": 4,

"pam_module_name": "LDAP"

},

{

106

"id": 4,

"pam_position": 2,

"pam_module_name": "RADIUS"

},

{

"id": 3,

"pam_position": 3,

"pam_module_name": "ACTIVE DIRECTORY"

}

]

2.47 PUT /api/settings/pam-order

Description: Modify PAM order settings

Request: Collection of PAM modules and their settings










Example:

Request:

[

{

"id": 1,

"pam_position": 3,

107


},

{

"id": 4,

"pam_position": 1,


},

{

"id": 3,

"pam_position": 2,


},

{

"id": 2,

"pam_position": 4,


}

]

Response:

[

{

"id": 1,

"pam_position": 3,


},

{

"id": 4,

"pam_position": 1,


},

{

"id": 3,

"pam_position": 2,


},

108

{

"id": 2,

"pam_position": 4,


}

]

2.48 GET /api/settings/services

Description: Retrieve all the services settings in BMC

Request: N/A



id Number Service Setting Identifier

service_id Number This property provides the Service Identifier

Web(1) KVM(2) cd-media(4) hd-media(16) ssh(ssh) solssh(128)

service_name String Name of the service

state Number Active status of the service

0 – Inactive

1 - Active

interface_name String It shows the interface on which service is running.


non_secure_port Number This property is used to configure non secure port

number for the service.

Web default port is 80. KVM default port is 7578. CD Media default port is 5120. FD Media default port is 5122. HD Media default port is 5123.

109

Telnet default port is 23. Port value ranges from 1 to 65535.

NOTE: SSH service will not support a non secure

port.

secure_port Number This property is used to configure secure port


Web default port is 443. KVM default port is 7582. CD Media default port is 5124. FD Media default port is 5126. HD Media default port is 5127. SSH default port is 22. Port value ranges from 1 to 65535.

NOTE: Telnet service will not support a secure

port.

time_out Number This property is specifies the session timeout value

of the service. For web, SSH and telnet service, user

can configure the session timeout value.

Web and KVM timeout value ranges from 300 to 1800 seconds.

Web timeout would be ignored if there exists any alive KVM session.

SSH and Telnet timeout value ranges from 60 to 1800 seconds.

Timeout value should be in multiples of 60 seconds.

NOTE: SSH and telnet service will be using the

same timeout value. If the user configures the SSH

timeout value, that will be applied to the telnet

service also, and vice versa.

maximum_sessions Number Maximum number of simultaneous sessions if

supported

active_session Number Number of active sessions currently alive

singleport_status Boolean Single Port status

Example:

110

Response:

[

{

"id": 1,

"service_id": 1,

"service_name": "web",

"state": 1,

"interface_name": "both",

"non_secure_port": 80,

"secure_port": 443,

"time_out": 1800,

"maximum_sessions": 148,

"active_session": 135,

"singleport_status": 1

},

{

"id": 2,

"service_id": 2,

"service_name": "kvm",

"state": 1,


"non_secure_port": -2147476070,

"secure_port": -2147476066,

"time_out": 1800,




},

{

"id": 3,

"service_id": 4,

"service_name": "cd-media",

"state": 1,



"secure_port": -2147478524,

111

"time_out": -1,




},

{

"id": 4,

"service_id": 8,

"service_name": "fd-media",

"state": 1,



"secure_port": -2147478522,

"time_out": -1,




},

{

"id": 5,

"service_id": 16,

"service_name": "hd-media",

"state": 1,



"secure_port": -2147478521,

"time_out": -1,




}

]

2.49 PUT /api/settings/services/{id}

Description: Modify all the services settings in BMC

Request:

112







0 – Inactive

1 - Active

interface_name String It shows the interface on which service is

running.




Web default port is 80. KVM default port is 7578. CD Media default port is 5120. FD Media default port is 5122. HD Media default port is 5123. Telnet default port is 23. Port value ranges from 1 to 65535.

NOTE: SSH service will not support a non

secure port.



Web default port is 443. KVM default port is 7582. CD Media default port is 5124. FD Media default port is 5126. HD Media default port is 5127.

113

SSH default port is 22. Port value ranges from 1 to 65535.


port.

time_out Number This property is specifies the session timeout

value of the service. For web, SSH and telnet

service, user can configure the session timeout

value.






same timeout value. If the user configures the

SSH timeout value, that will be applied to the

telnet service also, and vice versa.


supported








114



0 – Inactive

1 - Active

interface_name String It shows the interface on which service is running.




Web default port is 80. KVM default port is 7578. CD Media default port is 5120. FD Media default port is 5122. HD Media default port is 5123. Telnet default port is 23. Port value ranges from 1 to 65535.

NOTE: SSH service will not support a non secure

port.



Web default port is 443. KVM default port is 7582. CD Media default port is 5124. FD Media default port is 5126. HD Media default port is 5127. SSH default port is 22. Port value ranges from 1 to 65535.


port.

115

time_out Number This property is specifies the session timeout value

of the service. For web, SSH and telnet service, user

can configure the session timeout value.






same timeout value. If the user configures the SSH

timeout value, that will be applied to the telnet

service also, and vice versa.


supported



Example:

Request:

{

}

"id": 3,

"service_id": 4,


"state": 1,


"non_secure_port": "5120",

"secure_port": "5124",

"time_out": "-1",

"maximum_sessions": "",

"active_session": "",


116

Response:

{

"id": 3,

"service_id": 4,


"state": 1,


"non_secure_port": "5120",

"secure_port": "5124",

"time_out": "-1",

"maximum_sessions": "",

"active_session": "",


}

2.50 GET /api/settings/smtp

Description: Retrieve SMTP settings

Request: N/A



id Number SMTP Settings Identifier

channel_interface String This property provides the Interface name

Eth0 Eth1 Bond0

email_id String This property provides the Default origin email

address

primary_smtp_enable Boolean This property provide access to Enable primary

SMTP server

primary_server_name String This property provides the 'Machine Name' of the

SMTP Server.

Machine Name is a string of maximum 25 alpha-numeric characters.

117

Space, special characters are not allowed.

primary_smtp_port Number This property Specify the SMTP Port.

Default Port is 25. Port value ranges from 1 to 65535.

primary_smtp_secure_port

This property specify the SMTP Secure Port.


primary_server_ip String This property specify the 'IP address' of the SMTP

Server. It is a mandatory field.

Server address will support the following:


primary_smtp_authentication Boolean This propert provide access to enable SMTP

Authentication. Note: SMTP Server

Authentication Types supported are:

CRAM-MD5 LOGIN PLAIN

If the SMTP server does not support any one of

the above authentication types, the user will get

an error message stating, 'Authentication type is

not supported by SMTP Server'

primary_username String This property specify the username to access

SMTP Accounts.

User Name can be of length 4 to 64 alpha-numeric characters.

It must start with an alphabet. Special characters ','(comma), ':'(colon),

';'(semicolon), ' '(space) and '\'(backslash) are not allowed.

secondary_smtp_enable Boolean This property provide access to enable Secondary

SMTP support for the BMC.

118

primary_ssltls_enable Boolean This property provide access to enable SMTP

STARTTLS protocol.

ca_info1 String This property holds the uploaded CACERT.

CACERT key file should be of pem type.

cert_info1 String This property holds the uploaded CERT.

CERT key file should be of pem type.

key_info1 String This property holds the uploaded SMTP KEY.

SMTP key file should be of pem type.

secondary_server_ip String Enter the 'IP address' of the Secondary SMTP

Server.

secondary_smtp_authentication Boolean This property provide access to enable Secondary

SMTP Authentication.

NOTE: SMTP Server Authentication Types

supported are:






secondary_username String This property specifies the username to access

SMTP Accounts.

secondary_server_name String This property provides the 'Machine Name' of the

Secondary SMTP Server.



secondary_smtp_port Number This property Specify the Secondary SMTP Port.

Default Port is 25.

119


secondary_smtp_secure_port Number This property Specify the Secondary SMTP

Secure Port.


secondary_ssltls_enable Boolean This property Specify the Secondary SMTP

Secure Port.


secondary_starttls_enable Boolean This property provides access to enable SMTP

STARTTLS protocol.

ca_info2 String This property provides CA Certificate File Info


cert_info2 String This property provides Certificate File Info


key_info2 String This property provides Private key info

KEY file should be of pem type.

Example:

Response:

[

{

"id": 1,

"channel_interface": "eth0",

"email_id": "[email protected]",

"primary_smtp_enable": 1,

"primary_server_name": "test",

"primary_smtp_port": 25,

"primary_smtp_secure_port": 465,

"primary_smtp_authentication": 1,

"primary_server_ip": "10.0.125.100",

"primary_username": "test",

"primary_ssltls_enable": 0,

120

"primary_starttls_enable": 0,

"ca_info1": "",

"cert_info1": "",

"key_info1": "",

"secondary_smtp_enable": 1,

"secondary_server_name": "testserver2",

"secondary_smtp_port": 25,

"secondary_smtp_secure_port": 465,

"secondary_smtp_authentication": 1,

"secondary_server_ip": "10.0.124.15",

"secondary_username": "",

"secondary_ssltls_enable": 0,

"secondary_starttls_enable": 0,

"ca_info2": "",

"cert_info2": "",

"key_info2": ""

},

{

"id": 2,


"email_id": "",


"primary_server_name": "",




"primary_server_ip": "",

"primary_username": "",



"ca_info1": "",

"cert_info1": "",

"key_info1": "",


"secondary_server_name": "",


121



"secondary_server_ip": "",

"secondary_username": "",



"ca_info2": "",

"cert_info2": "",

"key_info2": ""

}

]

2.51 PUT /api/settings/smtp/{id}

Description: Modify SMTP settings

Request:




Eth0 Eth1 Bond0


address


SMTP server

primary_server_name String This property provides the 'Machine Name' of

the SMTP Server.



122


Default Port is 25.





primary_server_ip String This property specify the 'IP address' of the

SMTP Server. It is a mandatory field.












SMTP Accounts.


It must start with an alphabet. Special characters ','(comma),

':'(colon), ';'(semicolon), ' '(space) and '\'(backslash) are not allowed.

secondary_smtp_enable Boolean This property provide access to enable

Secondary SMTP support for the BMC.


STARTTLS protocol.

123








Server.

secondary_smtp_authentication Boolean This property provide access to enable

Secondary SMTP Authentication.


supported are:







SMTP Accounts.

secondary_server_name String This property provides the 'Machine Name' of

the Secondary SMTP Server.



secondary_smtp_port Number This property Specify the Secondary SMTP Port.


124


Secure Port.



Secure Port.



STARTTLS protocol.







primary_password String This property provides primary password

secondary_password String This property provides secondary password

Response:




Eth0 Eth1 Bond0


address

125


SMTP server

primary_server_name String This property provides the 'Machine Name' of

the SMTP Server.








primary_server_ip String This property specify the 'IP address' of the

SMTP Server. It is a mandatory field.












SMTP Accounts.


126

It must start with an alphabet. Special characters ','(comma),

':'(colon), ';'(semicolon), ' '(space) and '\'(backslash) are not allowed.

secondary_smtp_enable Boolean This property provide access to enable

Secondary SMTP support for the BMC.


STARTTLS protocol.








Server.

secondary_smtp_authentication Boolean This property provide access to enable

Secondary SMTP Authentication.


supported are:







SMTP Accounts.

secondary_server_name String This property provides the 'Machine Name' of

the Secondary SMTP Server.

127



secondary_smtp_port Number This property Specify the Secondary SMTP

Port.



Secure Port.



Secure Port.



STARTTLS protocol.







primary_password String This property provides primary password

secondary_password String This property provides secondary password

Example:

Request:

{

"id": 1,



128










"ca_info1": "",

"cert_info1": "",

"key_info1": "",







"secondary_username": "testuser",



"ca_info2": "",

"cert_info2": "",

"key_info2": "",

"primary_password": "tedst",

"secondary_password": "test@123"

}

Response:

{

"id": 1,







129






"ca_info1": "",

"cert_info1": "",

"key_info1": "",







"secondary_username": "testuser",



"ca_info2": "",

"cert_info2": "",

"key_info2": "",

"primary_password": "tedst",

"secondary_password": "test@123"

}

2.52 GET /api/ssl/certificate

Description: Retrieve certificate information

Request: N/A

Response:


id Number SSL certificate ID

certificate_version Number Version number of the certificate

serial_number String Certificate request serial number

130

signature_algorithm String This property specifies the algorithm used for

encryption

sha1WithRSAEncryption

public_key String SSL public key

from_common_name String Fully qualified domain of organization that issued

certificate

from_organization String Name of organization that issued certificate

from_organization_unit String Organization unit of organization that issued

certificate

from_city String City of organization that issued certificate

from_state String State of organization that issued certificate

from_country String Country of organization that issued certificate

from_email_id String Email of organization that issued certificate

valid_from String Date that certificate is valid from

valid_till String Date that certificate is valid up to

to_common_name String Fully qualified domain of organization that

certificate is issued to

to_organization String Name of organization that certificate is issued to

to_organization_unit String Organization unit of organization that certificate is

issued to

to_city String City of organization that certificate is issued to

to_state String State of organization that certificate is issued to

to_country String Country of organization that certificate is issued to

131

to_email_id String Email of organization that certificate is issued to

Example:

Response:

{

"id": 1,

"certificate_version": "1",

"serial_number": "9EC6A9B961F48A1C",

"signature_algorithm": "sha1WithRSAEncryption",

"public_key": "",

"from_common_name": "Testing",

"from_organization": "AMI",

"from_organization_unit": "Megarac",

"from_city": "Chennai",

"from_state": "TN",

"from_country": "IN",

"from_email_id": "[email protected]",

"valid_from": "Jan 11 05:15:41 2018 GMT",

"valid_till": "Jan 11 05:15:41 2019 GMT",

"to_common_name": "Testing",

"to_organization": "AMI",

"to_organization_unit": "Megarac",

"to_city": "Chennai",

"to_state": "TN",

"to_country": "IN",

"to_email_id": "[email protected]"

}

2.53 GET /api/settings/video/remote-storage

Description: Retrieve remote video recording settings

Request: N/A

Response:


132

remote_support Boolean 0: Disabled - video files will be stored in the local

path of the BMC.

1: Enabled - video files will be stored in the

configured remote server path.

ip_address String Address of the server where remote videos are to

be stored.

Its support the following formats:

IP Address (Both IPv4 and IPv6 format). FQDN (Fully qualified domain name)

format.

If remote support is enabled/checked this field is

required

remote_path String Full path to directory where the remote videos will

be stored.

And Special characters '<'(less than), '>'(greater

than), ':'(colon), '*'(asterisk), '|'(vertical bar),

'.'(dot), '?'(question mark) are not allowed.


required.

share_type String Share Type of the remote video server

NFS Samba (CIFS)

domain_name String Domain name for the remote server

username String Username for the remote server

If Samba is chosen this filed is required

password String Password for the remote server


133

max_dumps Number Maximum Dumps value should range from 1 to

100


required.

max_duration Number Maximum Duration should range from 1 to 3600

seconds


required.

max_size Number Maximum Size should range from 1 to 500 MB.


required.

Example:

Response:

{

"id": 1,

"remote_support": 0,

"mount_status": -1,

"max_dumps": 2,

"max_duration": 20,

"max_size": 5,

"ip_address": "",

"remote_path": "",

"share_type": "NFS",

"user_name": "",

"password": "",

"domain_name": ""

}

2.54 PUT /api/settings/video/remote-storage

Description: Configure remote server path to stored recorded video files.

Request:

134


remote_support Boolean 0: Disabled - video files will be stored in the local path

of the BMC.

1: Enabled - video files will be stored in the configured

remote server path.

ip_address String Address of the server where remote videos are to be

stored.

Its support the following formats:

IP Address (Both IPv4 and IPv6 format). FQDN (Fully qualified domain name) format.


required

remote_path String Full path to directory where the remote videos will be

stored.

And Special characters '<'(less than), '>'(greater than),

':'(colon), '*'(asterisk), '|'(vertical bar), '.'(dot),

'?'(question mark) are not allowed.


required.

share_type String Share Type of the remote video server

NFS Samba (CIFS)

domain_name String Domain name for the remote server

username String Username for the remote server


password String Password for the remote server


max_dumps Number Maximum Dumps value should range from 1 to 100

135


required.

max_duration Number Maximum Duration should range from 1 to 3600

seconds


required.

max_size Number Maximum Size should range from 1 to 500 MB.


required.



Error code Number 12001- Remote Video Configuration was saved

successfully and Mount settings will be reflected during

next video recording.

12000 - mount failure error code

Example:

Request:

domain_name:"test.com"

id:1

ip_address:"10.0.124.250"

max_dumps:2

max_duration:20

max_size:5

password:"user"

remote_path:"/home/video"

remote_support:1

share_type:"CIFS"

user_name:"testuser"

Response:

{

136

"error": "Mount settings will be reflected during next video recording.",

"code": 12001

}

2.55 GET /api/settings/video/triggers

Description: Retrieve video trigger settings

Request: N/A



id Number This property provides Trigger settings identifier

critical_events_enable Boolean This property having following values like below

for Critical Events (Temperature/Voltage).

0 - Disable

1 - Enable

non_critical_events_enable Boolean This property having following values like below

for Non Critical Events (Temperature/Voltage).

0 - Disable

1 - Enable

non_recoverable_events_enable Boolean This property having following values like below

for Non Recoverable Events

(Temperature/Voltage).

0 - Disable

1 - Enable

fan_state_events_enable Boolean This property having following values like below

for Fan state changed Events.

0 - Disable

1 - Enable

137

watchdog_events_enable Boolean This property having following values like below

for Watchdog Timer Events.

0 - Disable

1 - Enable

chasis_power_on_events_enabl

e

Boolean This property having following values like below

for Chassis Power On Events.

0 - Disable

1 - Enable

chasis_power_off_events_enabl

e


for Chassis Power Off Events.

0 - Disable

1 - Enable

chasis_reset_events_enable Boolean This property having following values like below

for Chassis Reset Events.

0 - Disable

1 - Enable

lpc_reset_events_enable Boolean This property having following values like below

for LPC Reset Events.

0 - Disable

1 - Enable

date_time_events_enable Boolean This property having following values like below

for Date and Time Event.

0 - Disable

1 - Enable

date_time_to_record Number This property provides unix timestamp mentioning

the date and time to record the video capture.

138

pre_event_video Number This property having following values like below

for Pre event video mode.

Disable

0 - Disable, Pre event video mode.

Enable

1 - Pre-crash support enabled

2 - Pre-reset support enabled

Example:

Response:

{

}

"id": 1,

"critical_events_enable": 1,

"non_critical_events_enable": 1,

"non_recoverable_events_enable": 0,

"fan_state_events_enable": 0,

"watchdog_events_enable": 0,

"chassis_power_on_events_enable": 1,

"chassis_power_off_events_enable": 0,

"chassis_reset_events_enable": 0,

"date_time_events_enable": 1,

"date_time_to_record": 1515607260,

"lpc_reset_events_enable": 0,

"pre_event_video": 2

2.56 PUT /api/settings/video/triggers

Description: Modify video trigger settings

Request:




139

0 - Disable

1 - Enable



0 - Disable

1 - Enable

non_recoverable_events_enable Boolean This property having following values like

below for Non Recoverable Events


0 - Disable

1 - Enable



0 - Disable

1 - Enable



0 - Disable

1 - Enable

chasis_power_on_events_enabl

e



0 - Disable

1 - Enable

chasis_power_off_events_enabl

e



0 - Disable

1 - Enable

140



0 - Disable

1 - Enable



0 - Disable

1 - Enable



0 - Disable

1 - Enable

date_time_to_record Number This property provides unix timestamp

mentioning the date and time to record the video

capture.



Disable


Enable





id Number This property provides Trigger settings identifier

141



0 - Disable

1 - Enable



0 - Disable

1 - Enable

non_recoverable_events_enable Boolean This property having following values like below

for Non Recoverable Events


0 - Disable

1 - Enable



0 - Disable

1 - Enable



0 - Disable

1 - Enable

chasis_power_on_events_enable Boolean This property having following values like below


0 - Disable

1 - Enable

chasis_power_off_events_enable Boolean This property having following values like below


142

0 - Disable

1 - Enable



0 - Disable

1 - Enable



0 - Disable

1 - Enable



0 - Disable

1 - Enable

date_time_to_record Number This property provides unix timestamp mentioning

the date and time to record the video capture.



Disable


Enable



Example:

Request:

chassis_power_off_events_enable:0

chassis_power_on_events_enable:1

chassis_reset_events_enable:0

143

critical_events_enable:1

date_time_events_enable:1

date_time_to_record:1515607260

fan_state_events_enable:0

lpc_reset_events_enable:0

non_critical_events_enable:1

non_recoverable_events_enable:0

pre_event_video:"2"

watchdog_events_enable:0

Response:

{

"id": 1,






"chassis_power_on_events_enable": 1,

"chassis_power_off_events_enable": 0,

"chassis_reset_events_enable": 0,




"pre_event_video": 2

}

2.57 GET /api/settings/users

Description: Retrieve all users

Request: N/A

Response: The response of the request will be in JSON format. The properties are mentioned in the following table.

144


id Number This property provides User Identifier for the user.

name String This property provides User name for the user.

access Boolean This property having following values like below for

access for the users.

0 - Disable

1 - Enable

kvm Boolean This property having following values like below for

KVM access for the users.

0 - Disable

1 - Enable

vmedia Boolean This property having following values like below for

VMedia access for the users.

0 - Disable

1 - Enable

snmp Boolean This property having following values like below for

SNMP access for the users.

0 - Disable

1 - Enable

prev_snmp Boolean This property having following values like below for

SNMP access for the users.

0 - Disable

1 - Enable

network_privilege String This property provides privilege value for the user in

BMC and its following possible value and each privilege

145

having some restriction to view or perform actions in the

page.

User Administrator Operator None OEM

fixed_user_count Number This property provides fixed user count and user can’t

view/change/delete these fixed users.

Default users count is 2 and a user’s are,

Id:

1 anonymous

2 admin

snmp_access String This property having following values like below for

SNMP access level for the users.

Read Only, Read Write, None.

OEMProprietary_level_Privile

ge

Boolean This property having following values like below for

OEM Proprietary level Privilege for the users.

This Boolean value used to display OEM privilege option

in user privilege field.

0 - Disable

1 - Enable

snmp_authentication_protocol String This property having following values like below for

SNMP Authentication protocol for the users.

MD5, SHA

snmp_privacy_protocol String This property having following values like below for

SNMP Privacy protocol for the users.

AES, DES

146

privilege_limit_serial String This property provides privilege value for the user in

BMC and its following possible value and each privilege

having some restriction to view or perform actions in the

page.


email_id String This property provides User’s mail id for the user.

email_format String This property having following values like below for

email format for the users and following format are the

possible.

AMI-Format:

The subject of this mail format is 'Alert from (your

Hostname)'. The mail content shows sensor information,

ex: Sensor type and Description.

FixedSubject-Format:

This format displays the message according to user's

setting. You must set the subject and message for email

alert.

ssh_key String This property provides SSH Key data for the user.

creation_time Timestamp This property provides User created time and it’s in unix

timestamp.

147

Example:

Response:

[

{

}

"id": 3,

"name": "user",

"access": 0,

"kvm": 0,

"vmedia": 0,

"snmp": 0,

"prev_snmp": 0,

"network_privilege": "none",

"fixed_user_count": 2,

"snmp_access": "read_only",

"OEMProprietary_level_Privilege": 1,

"privilege_limit_serial": "none",

"snmp_authentication_protocol": "sha",

"snmp_privacy_protocol": "des",

"email_id": "",

"email_format": "ami_format",

"ssh_key": "Not Available",

"creation_time": 1515417898

]

2.58 PUT /api/settings/users/{id}

Description: Create a new user in one of the empty user slots or modify a user in an existing user slot

Request:


Id Number This property provides User Identifier for the user.

name String This property provides User name for the user. This

name have the following rules.

User Name is a string of 1 to 16 alpha- numeric characters.

148

It must start with an alphabetical character.

It is case-sensitive. Special characters '-'(hyphen),

'_'(underscore), '@'(at sign) are allowed.

UserOperation Number This property provides the actions on the user. It can

be

0 – New User

1 – Modify User

changepassword Boolean This property only used in client side part to

validate the new password.

password_size String This property provides Size of the password [16

bytes, 20 bytes]

bytes_16 – password size must be less than 16


password String This property having following values like below

for password.

alphabets, numbers, symbols and upper case

characters

confirm_password String This property having following values like below

for password.

Alphabets, numbers, symbols and upper case

characters.

And this property only used in client side part to

confirm the new password.

Access Boolean This property having following values like below

for access for the users.

0 - Disable

1 - Enable

149

Kvm Boolean This property having following values like below

for KVM access for the users.

0 - Disable

1 - Enable

vmedia Boolean This property having following values like below

for VMedia access for the users.

0 - Disable

1 - Enable

Snmp Boolean This property having following values like below

for SNMP access for the users.

0 - Disable

1 - Enable

network_privilege String This property provides privilege value for the user

in BMC and its following possible value and each

privilege having some restriction to view or

perform actions in the page.


snmp_access String This property having following values like below

for SNMP access level for the users.


snmp_authentication_protocol String This property having following values like below

for SNMP Authentication protocol for the users.

MD5 SHA

snmp_privacy_protocol String This property having following values like below

for SNMP Privacy protocol for the users.

150

AES DES

privilege_limit_serial String This property provides privilege value for the user


privilege having some restriction to view or

perform actions in the page.



email_format String This property having following values like below

for email format for the users and following format

are the possible.

AMI-Format:


Hostname)'. The mail content shows sensor

information, ex: Sensor type and Description.


This format displays the message according to

user's setting. You must set the subject and message

for email alert.


And this field must be of pub type.ss

creation_time Timestamp This property provides User created time and it’s in

unix timestamp.

OEMProprietary_level_Privilege Boolean This property having following values like below

for OEM Proprietary level Privilege for the users.

This Boolean value used to display OEM privilege

option in user privilege field.

0 - Disable

151

1 - Enable

fixed_user_count Number This property provides fixed user count and user

can’t view/change/delete these fixed users.


Id:

1 anonymous

2 admin

prev_snmp Boolean This property having following values like below


0 - Disable

1 - Enable



Id Number This property provides User Identifier for the user.

name String This property provides User name for the user.

UserOperation Number This property provides the actions on the user. It can

be

0 – New User

1 – Modify User

changepassword Boolean This property only used in client side part to

validate the new password.

password_size String This property provides Size of the password [16

bytes, 20 bytes]



152

password String This property having following values like below

for password.

alphabets, numbers, symbols and upper case

characters

confirm_password String This property having following values like below

for password.

Alphabets, numbers, symbols and upper case

characters.

And this property only used in client side part to

confirm the new password.

Access Boolean This property having following values like below

for access for the users.

0 - Disable

1 - Enable

Kvm Boolean This property having following values like below

for KVM access for the users.

0 - Disable

1 - Enable

vmedia Boolean This property having following values like below

for VMedia access for the users.

0 - Disable

1 - Enable

Snmp Boolean This property having following values like below


0 - Disable

1 - Enable

153

network_privilege String This property provides privilege value for the user


privilege having some restriction to view or perform

actions in the page.


snmp_access String This property having following values like below

for SNMP access level for the users.


snmp_authentication_protocol String This property having following values like below

for SNMP Authentication protocol for the users.

MD5, SHA

snmp_privacy_protocol String This property having following values like below

for SNMP Privacy protocol for the users.

AES DES

privilege_limit_serial String This property provides privilege value for the user


privilege having some restriction to view or perform

actions in the page.



email_format String This property having following values like below

for email format for the users and following format

are the possible.

AMI-Format:

154


Hostname)'. The mail content shows sensor

information, ex: Sensor type and Description.


This format displays the message according to

user's setting. You must set the subject and message

for email alert.


And this field must be of pub type.

creation_time Timestamp This property provides User created time and it’s in

unix timestamp.

OEMProprietary_level_Privilege Boolean This property having following values like below

for OEM Proprietary level Privilege for the users.

This Boolean value used to display OEM privilege

option in user privilege field.

0 - Disable

1 - Enable

fixed_user_count Number This property provides fixed user count and user

can’t view/change/delete these fixed users.


Id:

1 anonymous

2 admin

prev_snmp Boolean This property having following values like below


0 - Disable

1 - Enable

Example:

155

New User Request:

OEMProprietary_level_Privilege:1

UserOperation:0

access:1

changepassword:1

confirm_password:"123456"

creation_time:0

email_format:null

email_id:""

fixed_user_count:2

id:4

kvm:1

name:"test"

network_privilege:"user"

password:"123456"

password_size:"bytes_16"

prev_snmp:0

privilege_limit_serial:"user"

snmp:0

snmp_access:null

snmp_authentication_protocol:null

snmp_privacy_protocol:null

ssh_key:"Not Available"

vmedia:1

Response:

{

"id": 4,

"name": "test",

"access": 1,

"kvm": 1,

"vmedia": 1,

"snmp": 0,

"prev_snmp": 0,

"network_privilege": "user",


"snmp_access": null,

156


"privilege_limit_serial": "user",

"snmp_authentication_protocol": null,

"snmp_privacy_protocol": null,

"email_id": "",

"email_format": null,


"creation_time": 0,

"changepassword": 1,

"UserOperation": 0,

"password": "123456",

"confirm_password": "123456",

"password_size": "bytes_16"

}

Modify User Request:

OEMProprietary_level_Privilege:1

UserOperation:1

access:1

changepassword:1

confirm_password:"12345678"

creation_time:1515470543

email_format:"ami_format"

email_id:""

fixed_user_count:2

id:4

kvm:1

name:"test"

network_privilege:"user"

password:"12345678"

password_size:"bytes_16"

prev_snmp:0

privilege_limit_serial:"user"

snmp:0

snmp_access:"read_only"

snmp_authentication_protocol:"sha"

snmp_privacy_protocol:"des"

157

ssh_key:"Not Available"

vmedia:1

Response:

{

"id": 4,

"name": "test",

"access": 1,

"kvm": 1,

"vmedia": 1,

"snmp": 0,

"prev_snmp": 0,

"network_privilege": "user",


"snmp_access": "read_only",


"privilege_limit_serial": "user",

"snmp_authentication_protocol": "sha",

"snmp_privacy_protocol": "des",

"email_id": "",

"email_format": "AMI-Format",


"creation_time": 1515470543,

"changepassword": 1,

"UserOperation": 1,

"password": "12345678",

"confirm_password": "12345678",

"password_size": "bytes_16"

}

2.59 DELETE /api/settings/users/{id}

Description: Delete a user

Request: N/A



158


0 – Successfully deleted the user.

Example

Response:

{ "cc": 0 }

2.60 POST /api/settings/user/ssh-key-upload/{id}

Description: Modify a user’s ssh-key

Request:


upload_ssh_key File Browse and upload the SSH key file to BMC and

it’s should be of pub type.




0 – Successfully uploaded to BMC for

corresponding user id.

Example

Response:

{ "cc": 0 }

2.61 GET /api/logs/system

Description: Retrieve system logs

Request:


Level Number This property sends the system log type to the BMC.

And the type are

1 - Alert

159

2 - Critical

3 - Error

4 - Notification

5 - Warning

6 - Debug

7 - Emergency

8 - Information



id Number This property provides Identifier for the system logs.

timestamp Number This property provides unix timestamp mentioning

the date and time of log created in BMC

hostname String This property provides Hostname of the BMC

message String This property provides Information on the log

record.

Example:

Request:

Level: 1

Response:

[{

}, {

"id": 1,

"timestamp": 1515404858,

"hostname": "AMI009089568967",

"message": "kernel: kernel - - [ 6.720000] Helper Module Driver Version 1.2 - "

"id": 2,

"timestamp": 1515404858,

"hostname": "AMI009089568967",

160

"message": "kernel: kernel - - [ 6.720000] Copyright (c) 2009-2015 American Megatrends Inc. - "

}]

2.62 GET /api/logs/video

Description: Retrieve video logs

Request: N/A



id Number This property provides Identifier for the Video

Logs

timestamp Number This property provides unix timestamp

mentioning the date and time of log created in

BMC

filename String This property provides File path of the recorded

video

Example

Response:

[{

}, {

}]

"id": 1,

"file": "AMI001000120032\/video_dump_2012y-01m-01d_00h-03m-24s.dat",

"timestamp": 1325394224,

"fileinfo": "Sun Jan 1 00:03:44 2012\n"

"id": 2,

"file": "AMI001000120032\/video_dump_2012y-01m-01d_00h-10m-49s.dat",

"timestamp": 1325394669,

"fileinfo": "Sun Jan 1 00:11:09 2012\n"

161

2.63 PUT /api/logs/video-log

Description: Set video logs

Request:


file_name String This property provides File path of the recorded

video

file_access Number This property provides File access of video log

4- Check file access

1- Set file access



id Number This property provides Identifier for the Video

Log


video

Example

Request:

file_name : "AMI001000120032/video_dump_2012y-01m-01d_00h-10m-49s.dat ",

file_access : "4"

Response:

{

"id": 1,

"file_name":"AMI001000120032/video_dump_2012y-01m-01d_00h-10m-49s.dat "

}

162

2.64 DELETE /api/logs/video-log/delete

Description: Delete video log

Request:



video to delete.




0 – Successfully deleted the recorded video from

the path.

Example

Request:

file_name : "cc"

Response:

{ "cc": 0 }

2.65 PUT /api/maintenance/flash

Description: Set flash mode and prepare flash area

Request: N/A

Response: N/A

2.66 POST /api/maintenance/firmware

Description: Upload firmware file

Request:


fwimage File Browse and upload the firmware file to BMC.


163



0 – Successfully uploaded a firmware image

to the BMC to perform Firmware flash.

Example

Response:

{ "cc": 0 }

2.67 GET /api/maintenance/firmware/verification

Description: Retrieve firmware image verification

Request: N/A



id Number This property provides Identifier for the

Component.

current_image_name String This property provides the component name

supported in BMC.

current_image_version1 String This property provides the existing

component version of image/image-1(Dual)

supported in BMC.

current_image_version2 String This property provides the existing

component version of image-2 supported in

BMC only for dual image firmware update.

new_image_version String This property provides the new component

version to be updated in BMC.

section_status Number This property provides the status of

component, only meaningful when section

based flash is enabled

164

verification_status Number This property provides the verification

status for the component.

Example

Response:

[{

}, {

}, {

}, {

"id": 1,

"current_image_name": "boot",

"current_image_version1": "2.5.000000",

"current_image_version2": "0.0.",

"new_image_version": "2.5.000000",

"section_status": 0,

"vesssrification_status": 32

"id": 2,

"current_image_name": "conf",





"verification_status": 32

"id": 3,

"current_image_name": "bkupconf",






"id": 4,

"current_image_name": "root",





165

}, {

}, {

}, {

}, {

}]


"id": 5,

"current_image_name": "osimage",






"id": 6,

"current_image_name": "www",






"id": 7,

"current_image_name": "testapps",






"id": 8,

"current_image_name": "ast2500e",






166

2.68 PUT /api/maintenance/firmware/upgrade

Description: Start firmware flashing

Request:


preserve_config Boolean This will preserve all the configuration settings

during the firmware update - irrespective of the

individual items marked as preserve/overwrite in

the preserve configuration table.

0 - Disable

1 - Enable

flash_status Number This property supports following flash methods.

1 - Full Firmware Flash

2 - Section Based Flash

3 - Version Compare Flash

section_count Number This property provides section count which user

have selected from the component table.

section_names Array of Strings This property provides collection of component

name which user have selected from the

component table.



preserve_config Boolean This will preserve all the configuration settings

during the firmware update - irrespective of the

individual items marked as preserve/overwrite in

the preserve configuration table.

0 - Disable

1 - Enable

167

flash_status Number This property supports following flash methods.

1 - Full Firmware Flash

2 - Section Based Flash

3 - Version Compare Flash

section_count Number This property provides section count which user

have selected from the component table.

section_names Array of Strings This property provides collection of component

name which user have selected from the

component table.

Example

Request:

flash_status:2

preserve_config:1

section_count:4

section_names:["boot", "conf", "osimage", "testapps"]

Response:

{

"preserve_config": 1,

"flash_status": 2,

"section_count": 4,

"section_names": ["boot", "conf", "osimage", "testapps"]

}

2.69 GET /api/maintenance/flash-progress

Description: Retrieve current flashing progress

Request: N/A



id Number This property provides Identifier for the flasher.

168

action String This property provides Current action in text.

progress String This property provides flash progress in %.

state Number This property provides Status of action

Example Response:

{ "id": 1,

"action": "Flashing...",

"progress": "20% done

"state": 0

}

2.70 POST /api/maintenance/reset

Description: Reset card

Request: N/A

Response: N/A

2.71 GET /api/maintenance/signed-image-key

Description: Retrieve signed image key information

Request: N/A



id Number This property provides Identifier for signed

image key.

key_exists Boolean This property provides information about key is

exists or not.

public_key_info String This property provides key information.

Example

Response:

{

169

"id": 1,

"key_exists": 0,

"public_key_info": ""

}

2.72 POST /api/maintenance/signed-image-key

Description: Upload signed image key

Request:


publicKey File Browse and upload the valid public key file to

BMC. After uploaded successfully immediately

called key validation.




0 – Successfully uploaded the key file into BMC

and immediately started to validate the uploaded

key.

Example

Response:

{ "cc": 0 }

2.73 GET /api/maintenance/signed-image-key-validity

Description: Retrieve signed image key validity

Request: N/A



id Number This property provides Identifier for the flasher.

170

validity Number This property provides to check Whether the key

is valid or not.

0 - valid

1310 - The SignImage Public Key file size

exceeds.

1311 - The SignImage Public Key file does not

exists.

1312 - Error in opening a file. SignImage

Validation failed.

1313, 1314 - The SignImage Public Key

validation failed.

Example

Response:

{

}

"id": 1,

"validity": 1

2.74 GET /api/maintenance/firmware/dual_image_config

Description: Retrieve dual image configuration

Request: N/A



id Number Dual image ID

fw1_major Number This property provides the Major version number of

first firmware image

fw1_minor Number This property provides the Minor version number of

first firmware image

171

fw1_aux Number This property provides the Auxiliary version

number of first firmware image

fw2_major Number This property provides the Major version number of

second firmware image

fw2_minor Number This property provides the Minor version number of

second firmware image

fw2_aux Number This property provides the Auxiliary version

number of second firmware image

active_image Number This property provides the Active image details

upload_image Number This property provides the Upload image details

boot_image Number This property provides the Boot image

reboot_bmc Boolean This property provides the Reboot BMC status

Example:

{ "id":

2,

"fw1_major":2

"fw1_minor":1

"fw1_aux":89271

"fw2_major":4

"fw2_minor":3

"fw2_aux":89456

"active_image":0

"upload_image":””

"boot_image":”rom.ima”

"reboot_bmc":0

}

2.75 PUT /api/maintenance/firmware/hpm/updatemode

Description: Enter HPM flash mode

Request: N/A

172



unique_id Number Unique ID of the firmware update

Example

Response:

{

"unique_id": 1

}

2.76 PUT /api/maintenance/firmware/hpm/exitupdatemode

Description: Exit HPM flash mode

Request:


FWUPDATEID Number Unique ID of the firmware update




Example

Request:

{

}

Response:

{

}

"FWUPDATEID ": 1

"cc ": 0

173

2.77 PUT /api/maintenance/firmware/hpm/preparecomponents

Description: Prepare HPM component for update

Request:


COMPONENT_ID Number ID of the component being updated

COMPONENT_DATA_LEN Number Length of the component update data


IS_MMC Number Flag for MMC updates






Example:

Request:

{ "COMPONENT_ID":

1,

“COMPONENT_DATA_LEN”: 4,

“FWUPDATEID” : 1 ,

“IS_MMC” : 1

}

Response:

{ "COMPONENT_ID":

1,


“FWUPDATEID” : 1

}

174

2.78 PUT /api/maintenance/firmware/hpm/flash

Description: Begin update of HPM component

Request:





SECTION_FLASH Number Flag for section based flashing






Example:

Request:

{ "COMPONENT_ID":

1,


“FWUPDATEID” : 1 ,

“SECTION_FLASH” : 1

}

Response:

{

"COMPONENT_ID":1,



}

175

2.79 GET /api/maintenance/firmware/hpm/upgradestatus

Description: Retrieve progress of HPM component upgrade

Request:






progress Number Progress of the flash upgrade (percentage)

Example:

Request:

{ "COMPONENT_ID"

:1

}

Response:

{

"COMPONENT_ID":1,

"progress" : "100%"

}

2.80 PUT /api/maintenance/firmware/hpm/verifyimage

Description: Begin verification of HPM component update

Request:





176




Example:

Request:

{ "COMPONENT_ID":

1,



}

Response:

{ "COMPONENT_ID"

:1

}

2.81 GET /api/maintenance/firmware/hpm/verifyimagestatus

Description: Retrieve progress of HPM component verification

Request:






progress Number Progress of the verification (percentage)

Example:

Request:

{ "COMPONENT_ID"

:1

}

177

Response:

{

}

"COMPONENT_ID":1,

"progress" : "100%"

2.82 GET /api/maintenance/firmware/hpm/componentversions

Description: Retrieve current version strings of specified HPM components

Request:


VERS_ID Number Comma-separated string of version IDs to check



id Number Collection Index

vers_id Number Component version ID

current_version String Version string of current component version

Example:

Request:

{ "VERS_ID":0,

1

}

Response:

[

{

"id": 0,

"vers_id": "0",

"current_version": "2.3.0"

},

{

"id": 1,

178

"vers_id": "1",

"current_version": "2.3.89271"

}

]

2.83 PUT /api/maintenance/firmware/hpm/activatecomponents

Description: Activate HPM component update

Request:






Example:

Request:

{ "COMPONENT_ID"

:1

}

Response:

{

"COMPONENT_ID":1

}

2.84 POST /api/maintenance/firmware/hpm/mmcfw

Description: Upload MMC firmware file

Request:

File upload



179


2.85 GET /api/configuration/project

Description: Retrieve names of all enabled features

Request: N/A



feature String This property provides the list of Features which

are enabled in the BMC.

Example:

Response:

[

{

"feature": "NWLINK"

},

{

"feature": "SYSTEM_FIREWALL"

},

{

"feature": "SYSTEM_FIREWALL_TIMEOUT"

},

{

"feature": "IPV6_SUPPORT"

},

{

"feature": "NWBONDING"

},

{

"feature": "POWER_CONSUMPTION"

},

{

"feature": "SERVICES"

180

},

{

"feature": "SESSION_MANAGEMENT"

},

{

"feature": "PRESERVECONF"

},

{

"feature": "FIRMWARE_FLASH_SUPPORT"

},

{

"feature": "SECTIONFLASH"

},

{

"feature": "VERSION_CMP_FLASH"

},

{

"feature": "FW_IMAGE"

},

{

"feature": "BACKUP_CONFIG"

},

{

"feature": "EXTENDED_PRIV"

},

{

"feature": "NTP_SERVER_SUPPORT"

},

{

"feature": "SINGLE_PORT_APP"

},

{

"feature": "RUNTIME_SINGLEPORT_SUPPORT"

},

{

"feature": "SNMP"

181

},

{

"feature": "RUNTIME_LICENSE"

},

{

"feature": "SAVE_SELLOG"

},

{

"feature": "SET_SENSOR_THRESHOLDS"

},

{

"feature": "WEB_APP_PROXY"

},

{

"feature": "TSIG"

},

{

"feature": "MDNS"

},

{

"feature": "TIMEZONE_SUPPORT"

},

{

"feature": "UARTLOG"

},

{

"feature": "UARTLOG_REMOTE"

},

{

"feature": "CIRCULAR_SEL"

},

{

"feature": "DISABLE_EMPTY_PASSWORD"

},

{

"feature": "OEM_PROPRIETARY_LEVEL_SUPPORT"

182

},

{

"feature": "IPV6_COMPLIANCE"

},

{

"feature": "INVENTORY_SUPPORT"

},

{

"feature": "HPM_SUPPORT"

},

{

"feature": "AUTOVDORECORD"

},

{

"feature": "AUTOVDORECORD_REMOTE"

},

{

"feature": "ADVISER_SUPPORT"

},

{

"feature": "KB_LANG_SELECT_SUPPORT"

},

{

"feature": "RUNTIME_HOST_LOCK"

},

{

"feature": "HOST_LOCK_AUTO"

},

{

"feature": "KVM_SESSION_TIMEOUT"

},

{

"feature": "KVM_SESSION_RECONNECT"

},

{

"feature": "HTML5_KVM"

183

},

{

"feature": "AUTO_RESIZE_KVM_CLIENT_WINDOW"

},

{

"feature": "MEDIA_REDIR_READ_WRITE_ONLY"

},

{

"feature": "JAVA_CD_IMAGE_REDIR"

},

{

"feature": "MULTIPLE_USER_VMEDIA"

},

{

"feature": "VMEDIA_MAX_COUNT_FOR_KVM"

},

{

"feature": "IMG_REDIRECTION"

},

{

"feature": "LMEDIA"

},

{

"feature": "IMG_REDIRECTION"

},

{

"feature": "RMEDIA"

},

{

"feature": "SD_SERVER_SUPPORT"

},

{

"feature": "NCSI_SUPPORT"

},

{

"feature": "PAM_REORDERING"

184

},

{

"feature": "AD_SUPPORT"

},

{

"feature": "LDAP_SUPPORT"

},

{

"feature": "RADIUS_SUPPORT"

}

]

2.86 GET /api/fru

Description: Retrieve FRU information

Request: N/A



Device Object Device information like

Id Name

common_header Object This property provides below FRU header

information

Version internal_use_area_start_offset chassis_info_area_start_offset board_info_area_start_offset product_info_area_start_offset multi_record_area_start_offset

Chassis Object This property provides below Information about

chassis

version internal_use_area_start_offset board_info_area_start_offset product_info_area_start_offset multi_record_area_start_offset

185

Board Object This property provides below Information about

board

version length language date manufacturer product_name serial_number part_number fru_file_id custom_fields

Product Object This property provides below Information about

product

version length language manufacturer product_name part_number fru_file_id custom_fields asset_tag product_version

Example:

Response:

[{

"device": {

"id": 0,

"name": "FRU Device"

},

"common_header":

{ "version": 1,

"internal_use_area_start_offset": 0,

"chassis_info_area_start_offset": 1,

"board_info_area_start_offset": 5,

"product_info_area_start_offset": 12,

"multi_record_area_start_offset": 0

},

186

"chassis": {

"version": 1,

"length": 4,

"type": "Main Server Chassis",

"part_number": "XXX-ENCL0014-0001",

"serial_number": "00000000",

"custom_fields": null

},

"board": {

"version": 1,

"length": 7,

"language": 0,

"date": "Fri Mar 21 07:41:00 2014",

"manufacturer": "Netronome",

"product_name": "Nemesis",

"serial_number": "13500003",

"part_number": "AMDA0056-0001",

"fru_file_id": "",


},

"product": {

"version": 1,

"length": 5,

"language": 0,

"manufacturer": "Netronome",

"product_name": "Nemesis",

"part_number": "...",

"product_version": "...",

"serial_number": "...",

"asset_tag": "...",

"fru_file_id": "",


}

187

}]

2.87 GET /api/kvm/token

Description: Retrieve KVM token

Request: N/A



Token String KVM token

Session String Session ID

Example:

Response:

{

}

"token": "xCSDFQSasdasd",

"session": "xzxSQsdFDFGWQCsdq234sdf="

2.88 GET /api/maintenance/backup_config

Description: Retrieve information about the configuration backup options

Request: N/A



Id Number Backup configuration ID

Kvm Boolean Mark KVM options to be backed up

Network Boolean Mark network options to be backed up

Ipmi Boolean Mark IPMI options to be backed up

Ntp Boolean Mark NTP options to be backed up

authentication Boolean Mark authentication options to be backed up

188

Syslog Boolean Mark system log options to be backed up

Example:

Response:

{

"id": 1,

"kvm": 0,

"network": 1,

"ipmi": 1,

"ntp": 1,

"authentication": 1,

"syslog": 1

}

2.89 PUT /api/maintenance/backup_config

Description: Set information about the configuration backup options

Request:


Kvm Boolean Mark KVM options to be backed up

network Boolean Mark network options to be backed up

Ipmi Boolean Mark IPMI options to be backed up



syslog Boolean Mark system log options to be backed up



kvm Boolean Mark KVM options to be backed up

189

services Boolean Mark services options to be backed up

network Boolean Mark network options to be backed up

ipmi Boolean Mark IPMI options to be backed up



syslog Boolean Mark system log options to be backed up

Example:

Request:

{

}

"id": 1,

"kvm": 0,

"network": 1,

"ipmi": 1,

"ntp": 1,


"syslog": 1

Response:

{

"id": 1,

"kvm": 0,

"network": 1,

"ipmi": 1,

"ntp": 1,


"syslog": 1

}

2.90 GET api/maintenance/bmc_recovery

Description: Retrieve the BMC recovery configurations

Request: N/A

190



forceRecovery Number This property provides the force recovery value

bootRetryCount Number This property provides the boot retry count value

recoveryRetryCount Number This property provides the recovery retry count

value

serverAddress String This property provides the server address

imageName String This property provides the image name

Example:

{

}

"forceRecovery": 1,

"bootRetryCount": 5,

"recoveryRetryCount": 5,

"serverAddress": "10.0.6.18",

"imageName": "rom.ima"

2.91 PUT api/maintenance/bmc_recovery

Description: Set the BMC recovery configurations

Request:




recoveryRetryCount Number This property provides the recovery retry count value



191





recoveryRetryCount Number This property provides the recovery retry count value



Example:

{

}

"forceRecovery": 1,

"bootRetryCount": 5,

"recoveryRetryCount": 5,

"serverAddress": "10.0.6.18",

"imageName": "rom.ima"

2.92 GET api/maintenance/download_config

Description: Download the backup configuration file

Request: N/A



File Blod Downloading file as bmc-config.bak

Example:

File response as text and save as bmc-config.bak

2.93 GET api/ maintenance/fwimage_location

Description: To get Firmware image location

Request: N/A

192



Id Number Identifier of the user record

protocol_type String This property provides the protocol type

http tftp

server_address String This property provides the server address

image_name Number This property provides the image name

retry_count Number This property provides the retry count

Example:

Response:-

{

"id": 1,

"protocol_type": "tftp",


"image_name": "ami.ima",

"retry_count": 3

}

2.94 PUT api/ maintenance/fwimage_location

Description: Set Firmware image location

Request:




http

tftp

193








http tftp




Example:

Request:

{

}

"id": 1,




"retry_count": 3

Response:-

{

"id": 1,




"retry_count": 3

}

194

2.95 PUT /api/maintenance/preserve

Description: Set preserve configuration details

Request: N/A




Sdr Number This property provides the restore default enable

/disable

Enable (1)

Disable (0)

Fru Number This property provides the restore default enable

/disable

Enable (1)

Disable (0)

Sel Number This property provides the restore default enable

/disable

Enable (1)

Disable (0)

Ipmi Number This property provides the restore default enable

/disable

Enable (1)

Disable (0)

network Number This property provides the restore default enable

/disable

Enable (1)

Disable (0)

195

Ntp Number This property provides the restore default enable

/disable

Enable (1)

Disable (0)

snmp Number This property provides the restore default enable

/disable

Enable (1)

Disable (0)

Ssh Number This property provides the restore default enable

/disable

Enable (1)

Disable (0)

Kvm Number This property provides the restore default enable

/disable

Enable (1)

Disable (0)

authentication Number This property provides the restore default enable

/disable

Enable (1)

Disable (0)

syslog Number This property provides the restore default enable

/disable

Enable (1)

Disable (0)

Example:

{

"id": 1,

196

"sdr": 0,

"fru": 0,

"sel": 0,

"ipmi": 0,

"network": 0,

"ntp": 0,

"snmp": 0,

"ssh": 0,

"kvm": 0,


"syslog": 0

}

2.96 GET /api/maintenance/preserve

Description: Retrieve preserve configuration details

Request: N/A




Sdr Number This property provides the restore default enable

/disable

Enable (1)

Disable (0)

Fru Number This property provides the restore default enable

/disable

Enable (1)

Disable (0)

sel Number This property provides the restore default enable

/disable

Enable (1)

197

Disable (0)

ipmi Number This property provides the restore default enable

/disable

Enable (1)

Disable (0)

network Number This property provides the restore default enable

/disable

Enable (1)

Disable (0)

Ntp Number This property provides the restore default enable

/disable

Enable (1)

Disable (0)

snmp Number This property provides the restore default enable

/disable

Enable (1)

Disable (0)

Ssh Number This property provides the restore default enable

/disable

Enable (1)

Disable (0)

Kvm Number This property provides the restore default enable

/disable

Enable (1)

Disable (0)

198

authentication Number This property provides the restore default enable

/disable

Enable (1)

Disable (0)

syslog Number This property provides the restore default enable

/disable

Enable (1)

Disable (0)

Example:

{

}

"id": 1,

"sdr": 0,

"fru": 0,

"sel": 0,

"ipmi": 0,

"network": 0,

"ntp": 0,

"snmp": 0,

"ssh": 0,

"kvm": 0,


"syslog": 0

2.97 POST /api/maintenance/upload_restore

Description: Upload backup configuration file

Request: Upload backup config file



199

Cc Number Success / Error code

Example:

{ "cc": 0 }

2.98 GET api/maintenance/system_admin

Description: Retrieve System Admin Configuration

Request: N/A




enable_change_password Number Enable or Disable change password option

Disable (0)

Enable (1)

enable_user_access Number Enable or Disable user access

Disable (0)

Enable (1)

username String This property provides the username

Example:

[{

"id": 1,

"enable_change_password": 0,

"enable_user_access": 1,

"username": "sysadmin"

}}]

2.99 PUT api/maintenance/system_admin

Description: Set System Admin Configuration

Request:

200




Disable (0)

Enable (1)


Disable (0)

Enable (1)


password String This property provides the password

cpassword String This property provides the confirmation

password





Disable (0)

Enable (1)


Disable (0)

Enable (1)


password String This property provides the password

201

cpassword String This property provides the confirmation password

Example:

{

"enable_change_password": 1,

"enable_user_access": 1,

"id": 1,

"username": "sysadmin",

"password": "superuser",

"cpassword": "superuser"

}

2.100 GET api/scripts

Description: Retrieve Automation Engine scripts

Request: N/A




Name String Name of the script

Code String Code contents of script

Example:

[{

"id": 1,

"name": "Monitor SEL size",

"code": "print 'test'"

}]

2.101 POST api/scripts

Description: Create Automation Engine script

Request:


202

name String Name of the script

code String Code contents of script



name String Name of the script

code String Code contents of script

Example:

[{

"name": "Monitor SEL size",

"code": "print 'test'"

}]

2.102 DELETE api/scripts/{id}

Description: Delete particular Automation Engine script

Request:





Cc Number Status of the Operation

Example:

{

"cc": 0

}

2.103 GET /api/settings/channels

Description: Retrieve NCSI channels

203

Request: N/A




package_id Number Package Id

channel_number Number Channel Number

Example:

[{

}]

"id": 1,

"package_id": 1,

"channel_number": 0

2.104 GET /api/settings/firewall

Description: Retrieve general firewall configuration

Request: N/A




block_all String IPv4, IPv6

flush_all Number Flush all rules

timeout Number Timeout

start_time Number Time to start configuration

end_time Number Time to end configuration

Example:

204

[ {

"id": 1,

"block_all": "IPV4",

"flush_all": 0,

"timeout": 1,

"start_time": 1406939138,

"end_time": 1408939138

}, {

"id": 2,


"flush_all": 0,

"timeout": 1,

"start_time": 1406939138,

"end_time": 1408939138

}]

2.105 POST /api/settings/firewall

Description: Create new general firewall configuration

Request:










205






Example:

[ {


"flush_all": 0,

"timeout": 1,

"start_time": 1406939138,

"end_time": 1408939138

}]

2.106 GET /api/settings/firewall-ip-rule

Description: Retrieve IP firewall rules

Request: N/A




ip_start String Starting IP for rule

ip_end String Ending IP for rule

Rule String Block or allow

timeout Boolean Enable timeout for rule

start_time Number Starting time for rule

206

end_time Number Ending time for rule

Example:

[ {

"id": 1,

"ip_start": "172.16.97.59",

"ip_end": "",

"rule": "block",

"timeout": 1,

"start_time": 1408939138,

"end_time": 1416939138

}]

2.107 POST /api/settings/firewall-ip-rule

Description: Create new or modify existing firewall IP rule

Request:












207







Example:

[ {

"id": 1,

"ip_start": "172.16.97.59",

"ip_end": "",

"rule": "block",

"timeout": 1,

"start_time": 1408939138,

"end_time": 1416939138

}]

2.108 DELETE /api/settings/firewall-ip-rule

Description: Delete firewall IP rule

Request:






Example:

{

208

"cc": 0

}

2.109 GET /api/settings/firewall-port-rules

Description: Retrieve firewall port rules

Request: N/A




port_start Number This property provides the port start value

port_end Number This property provides the port end value

protocol Number This property provides the protocol value like

below.

UDP (1) TCP (2)

Rule String This property provides the rule value like below.

Block Allow

timeout Boolean This property provides the timeout value

start_time Number This property provides the start time value

end_time Number This property provides the end time value

network_type String This property provides the network value like

below

IPv4 IPv6

Example:

[ {

"id": 1,

"port_start": "250",

"port_end": "300",

209

"protocol": 1,

"rule": "allow",

"timeout": 1,

"start_time": 1408939138,

"end_time": 1416939138,

"network_type": "IPV4"

}]

2.110 POST /api/settings/firewall-port-rules

Description: Create new firewall port rule or modify existing rule

Request:






below.

UDP (1) TCP (2)


Block Allow





below

IPv4 IPv6


210






below.

UDP (1) TCP (2)


Block Allow





below

IPv4 IPv6

Example:

[ {

"id": 1,

"port_start": "250",

"port_end": "300",

"protocol": 1,

"rule": "allow",

"timeout": 1,

"start_time": 1408939138,

"end_time": 1416939138,

"network_type": "IPV4"

}]

211

2.111 DELETE /api/settings/firewall-port-rules{{id}}

Description: Delete firewall IP rule

Request:






Example:

{

}

"cc": 0

2.112 GET /api/settings/licenses

Description: Retrieve licenses configuration

Request: N/A




feature String This property provides the Name of the feature

validity String This property provides the Validity days of the

license

Example:

[

{

"id": 1,

"feature": "KVM",

212

"validity": "30 days"

}

]

2.113 POST /api/settings/licenses

Description: Create new license

Request:


license_key String This property provides the License key value



license_key String This property provides the License key value

Example:

{

}

"new": 0

2.114 GET /api/settings/mouse

Description Retrieve KVM mouse mode

Request: N/A



mode String This property provides the Mouse mode like below

Absolute relative other

Example:

{

"id": 1,

"mode": "absolute"

213

}

2.115 PUT /api/settings/mouse

Description Set KVM mouse mode

Request: N/A



mode String This property provides the Mouse mode like

below

Absolute relative other

Example:

{

}

"id": 1,

"mode": "absolute"

2.116 GET /api/settings/ncsi/mode

Description Retrieve NCSI mode

Request:


interface_name String This property provides the Interface name




mode Number This property provides the NCSI mode

Example:

Request:

{

214

}

Response:

{

interface_name: “Eth1”

Mode: 1

}

2.117 PUT /api/settings/ncsi/mode

Description Retrieve NCSI mode

Request:


channel_number Number This property provides the Channel number

package_id Number This property provides the Package ID





channel_number Number This property provides the Channel number




Example:

Request:

{

"package_id": 1,


“ interface_name”: “Eth1”

}

215

Response:

{

"package_id": 1,


“ interface_name”: “Eth1”

}

2.118 GET /api/settings/network-interfaces

Description Retrieve network interface configurations

Request: N/A



Id Number This property provides the Network interface ID



Example:

[

{

}

]

"id": 1,

"interface_name": "eth0"

2.119 GET /api/settings/packages

Description Retrieve NCSI package configuration

Request: N/A



Id Number This property provides the Package ID in

collection

216


Example:

[

{"id": 1, "package_id": 1},

{"id": 2, "package_id": 2}

]

2.120 GET /api/settings/pef/alert_policies

Description Retrieve PEF alert policies

Request: N/A


217



policy_group String This property provides the policy group (1 - 15)

enable_policy Boolean This property provides the enable disable policy

Enable (1)

Disable (0)

policy_action String Choose any one of the Policy set values from the

list.

0 - Always send alert to this destination.

1 - If alert to previous destination was successful,

do not send alert to this destination. Proceed to

next entry in this policy set.


do not send alert to this destination. Do not

process any more entries in this policy set.



next entry in this policy set that is to a different

channel.




destination type

channel_number Number Choose a particular destination from the

configured destination list.

destination_id String Choose a particular destination selector from the

configured destination selector list. Range (1-15)

alert_string String Enable or Disable Event Specific Alert String

218

Enable (1)

Disable (0)

alert_string_key String Choose from a set of values, all linked to strings

kept in the PEF configuration parameters, to

specify which string is to be sent for this Alert

Policy entry. Range (0-127)

Example:

[

{

}

]

"id": 1,

"policy_group": "1",

"enable_policy": 0,

"policy_action": "always_send_alert",


"destination_id": "0",

"alert_string": 0,

"alert_string_key": "0"

2.121 PUT /api/settings/pef/alert_policies

Description Create or modify new event filter

Request:





Enable (1)

Disable (0)

219


list.











channel.




destination type






Enable (1)

Disable (0)




Policy entry.


220





Enable (1)

Disable (0)


list.











channel.




destination type






221

Enable (1)

Disable (0)




Policy entry.

Example:

Request:

{

}

"id": 1,


"enable_policy": 0,


"channel_number": "1",


"alert_string": 0,


Response:

{

"id": 1,


"enable_policy": 0,




"alert_string": 0,


}

2.122 DELETE /api/settings/pef/alert_policies/{id}

Description: Delete Alert Policies

Request:

222






Example:

{

}

"cc": 0

2.123 GET /api/settings/pef/lan_destinations

Description: Retrieve alert destinations

Request: N/A




channel_id Number LAN Channel Number of the selected slo

destination_address String Destination number of the selected slot

name String This property provides the name of the user

lan_channel Number This property provides the configured

lan_channel number

destination_type String This property provides the configured destination

type

subject String This property provides the given email subject

223

message String This property provides the given message

Example:

[

{

}

]

"channel_id": 1,

"id": 1,

"destination_address": "",

"name": "",

"lan_channel": 1,

"destination_type": "snmp",

"subject": "",

"message": ""

2.124 GET /api/settings/pef/event_filters

Description Retrieve event filters

Request: N/A




enable_filter Number This property provides access to Enable / Disable

PEF event filter settings

Enable (1)

Disable (0)

224

trigger_event_severity String This property provides the triggered event

severity.

unspecified - Any severity monitor - New monitor state information - New information normal - Normal state non_critical - Non-Critical state

225

critical - Critical state non_recoverable - Non-Recoverable

state

power_action String This property provides the power_action.

none - None power_down – Power Down power_cycle – Power Cycle power_reset - Reset

policy_group Number This property provides the policy group. Range (1

-15)

generator_id_1 Number This property provides the the raw generator ID1

data value.


data value.

NOTE: In the RAW data field, to specify

hexadecimal value prefix the value with '0x'.

sensor_type String This property provides The type of sensor that will

trigger the event filter action.

temperature Fan Voltage Discrete

Name String This property provides the sensor name

All Sensors Temp_1 Temp_5 Chassis_Intr Voltage_VCC Fan_1 Fan_2 Temp_3 Temp_4 Voltage_2.5V Voltage_5V Voltage1_12V Temp_2 SEL_sensor Watchdog2 Test_001

226

sensor_num Number This property provides the sensor number

event_trigger Number This property provides the Event/Reading type

value.


event_data_1_offset_mask Number This property provides the event data 1

event_data_1_and_mask Number This property provides the wildcarded or

compared bits.


event_data_1_compare_1 Number This property indicate whether each bit position's

comparison is an exact comparison or not.





event_data_2_and_mask Number This property is similar to Event Data 1 AND

Mask.

event_data_2_compare_1 Number This property is similar to Event Data 1 Compare

1


2


Mask.


1


2

raw_data Number Enable / Disable the Generator ID with raw data.

227

Enable (1)

Disable (0)

generator_type String Choose generator type

slave software

Choose the event generator as Slave Address - if

event is generated from IPMB

event_options String Event option to be either All events or Sensor

specific events

Lower Non-Critical Lower Critical Lower Non-Recoverable Upper Non-Critical Upper Critical Upper Non-Recoverable

Example:

[

{

"id": 1,

"enable_filter": 1,

"trigger_event_severity": "unspecified",

"power_action": "none",

"policy_group": 1,

"generator_id_1": 255,


"sensor_type": "Any",

"name": "All Sensors",

"sensor_num": 255,

"event_trigger": 255,

"event_data_1_offset_mask": 65535,

"event_data_1_and_mask": 0,

"event_data_1_compare_1": 0,




228





"raw_data": 1,

"generator_type": "",

"event_options": "all"

}

]

2.125 PUT /api/settings/pef/event_filters/{id}

Description Modify / Create event filter

Request: N/A





Enable (1)

Disable (0)


severity.

unspecified - Any severity monitor - New monitor state information - New information normal - Normal state non_critical - Non-Critical state critical - Critical state non_recoverable - Non-Recoverable

state



229


-15)


data value.


data value.










value.



230


compared bits.









Mask.


1


2


Mask.


1


2


Enable (1)

Disable (0)


slave software

231




specific events







Enable (1)

Disable (0)


severity.

unspecified - Any severity monitor - New monitor state information - New information normal - Normal state non_critical - Non-Critical state critical - Critical state non_recoverable - Non-Recoverable

state




-15)

230


data value.


data value.










value.




compared bits.

232









Mask.


1


2


Mask.


1


2


Enable (1)

Disable (0)


slave software



233


specific events


Example:

[

{

"id": 2,

"enable_filter": 1,

"trigger_event_severity": "unspecified",

"power_action": "none",

"policy_group": 2,



"sensor_type": "Any",

"name": "All Sensors",

"sensor_num": 255,

"event_trigger": 255,

"event_data_1_offset_mask": 65535,










"raw_data": 1,

"generator_type": "slave",

"event_options": "all",

"slave_addr_software_id": "",


234

"ipmb_lun": "0"

}

]

2.126 DELETE /api/settings/pef/event_filters/{id}

Description: Delete particular Event Filter

Request:






Example:

{

}

"cc": 0

2.127 GET /api/settings/pef/lan_destinations

Description: Get all LAN Destination details.

Request: N/A



channel_id Number This property provides the configured Channel

Id


destination_address String This property provides the Destination Address

Supports IPv4 IPv6 format

235

Name String This property provides the BMC User Name

lan_channel Number This property provides the Lan Channel Number

destination_type String This property provides the Destination Type

SNMP Trap Email

Subject String This property provides the Subject of the

message

Message String This property provides the Message Content

Example:

{

}

"channel_id": 1,

"id": 1,

"destination_address": "10.0.124.75",

"name": "user",

"lan_channel": 1,

"destination_type": "email",

"subject": "",

"message": "",

"format": "ami_format"

2.128 PUT /api/settings/pef/lan_destinations

Description: Get all LAN Destination details.

Request:


channel_id Number This property provides the configured Channel Id




236




SNMP Trap Email

Subject String This property provides the Subject of the message

Message String This property provides the Message Content

Format String Email format for AMI standard or other mail



channel_id Number This property provides the configured Channel Id







SNMP Trap Email

Subject String This property provides the Subject of the message

message String This property provides the Message Content

Format String Email format for AMI standard or other mail

Example:

{

237

"channel_id": 1,

"id": 1,

"destination_address": "10.0.124.75",

"name": "user",

"lan_channel": 1,

"destination_type": "email",

"subject": "",

"message": "",

"format": "ami_format"

}

2.129 DELETE /api/settings/pef/lan_destinations /{id}

Description: Delete particular LAN Destination

Request:






Example:

{

}

"cc": 0

2.130 GET / api/settings/radius/general

Description: Retrieve general RADIUS configuration

Request: N/A



238


enable Number This property provides the Enable /Disable

Radius Authentication

Enable (1)

Disable (0)

server_address String This property provides the Server Address


FQDN (Fully Qualified Domain Name) format.

port Number This property provides the Port Number


secret String This property provides the Secret

Secret must be at least 4 characters long.

White space is not allowed.

NOTE: This field will not allow more than 31

characters.

kvm Number This property provides the Enable / Disable KVM

Enable (1)

Disable (0)

vmedia Number This property provides the Enable / Disable

Vmedia

Enable (1)

Disable (0)

Example:

{

"id": 1,

"enable": 0,

"server_address": "",

239

"port": 1812,

"secret": "",

"kvm": 0,

"vmedia": 0

}

2.131 POST / api/settings/radius/general

Description: Set general RADIUS configuration

Request:



enable Number This property provides the Enable /Disable

Radius Authentication

Enable (1)

Disable (0)



FQDN (Fully Qualified Domain Name) format.




Secret must be at least 4 characters long.

White space is not allowed.


characters.

kvm Number This property provides the Enable / Disable

KVM

Enable (1)

240

Disable (0)


Vmedia

Enable (1)

Disable (0)




enable Number This property provides the Enable /Disable Radius

Authentication

Enable (1)

Disable (0)


IP Address (Both IPv4 and IPv6 format). FQDN (Fully Qualified Domain Name)

format.




Secret must be at least 4 characters long. White space is not allowed.


characters.

kvm Number This property provides the Enable / Disable KVM

Enable (1)

Disable (0)

241


Vmedia

Enable (1)

Disable (0)

Example:

Request:

{"id":1,"enable":1,"server_address":"10.0.124.75","port":"1812","secret":"test","kvm":1,"vmedi a":1}

Response:-

{

"id": 1,

"enable": 1,


"port": "1812",

"secret": "test",

"kvm": 1,

"vmedia": 1

}

2.132 GET /api/settings/radius/advanced

Description: Retrieve advanced RADIUS configuration

Request: N/A



administrator String administrator radius privilege

operator String operator radius privilege

user String user radius privilege

oem String oem radius privilege

none String none radius privilege

242

Example:

{

}

"administrator": "H=4",

"operator": "H=3",

"user": "H=2",

"oem": "H=1",

"none": "H=0"

2.133 POST /api/settings/radius/advanced

Description: Set advanced RADIUS configuration

Request:














Example:

243

{

"administrator": "H=4",

"operator": "H=3",

"user": "H=2",

"oem": "H=1",

"none": "H=0"

}

2.134 GET /api/settings/sensor-threshold

Description: Retrieve sensor threshold values

Request: N/A




sensor_number Number This property provides the sensor number


sensor_type_number Number This property provides the sensor type name

lower_non_recoverable_threshold Number This property provides the lower non

recoverable threshold

lower_critical_threshold Number This property provides the lower critical

threshold

lower_non_critical_threshold Number This property provides the lower non critical

threshold

higher_non_critical_threshold Number This property provides the high non critical

threshold

higher_critical_threshold Number This property provides the high critical

threshold

244

higher_non_recoverable_threshold Number This property provides the higher non


Example:

{

}

"id": 65,

"sensor_number": 65,

"name": "Test_001",

"sensor_type_number": 1,






"higher_non_recoverable_threshold": 60.000000

2.135 PUT /api/settings/sensor-threshold

Description: Set sensor threshold values

Request:









threshold

245


threshold


threshold


threshold












threshold


threshold


threshold


threshold

246



Example:

Request:-

{

}

"id": 65,


"name": "Test_001",








Response:

{

"id": 65,


"name": "Test_001",








}

2.136 GET api/settings/ssl/certificate-info

Description: Retrieve SSL Certificate Information.

Request: N/A


247



certificate_available Number This property provides the certificate already

available / Un available

Available (1)

Un Available (0)

certificate_date String This property provides the certificate creation date

private_key_date String This property provides the private key date

Example:

{

}

"certificate_available": 1,

"certificate_date": "Thu Mar 10 19:17:29 2016\n",

"id": 1,

"private_key_date": ""

2.137 PUT api/settings/ssl/certificate-info


Request: N/A




certificate_available Number This property provides the certificate already

available / Un available

Available (1)

Un Available (0)

248

certificate_date String This property provides the certificate creation

date

private_key_date String This property provides the private key date

Example:

Request:

{"id":1,"certificate_available":1,"certificate_date":"Thu Mar 10 19:17:29 2016\n","private_key_date":""}

Response:

{

"certificate_available": 1,

"certificate_date": "Thu Mar 10 19:17:29 2016\n",

"id": 1,

"private_key_date": ""

}

2.138 GET api/settings/ssl/certificate


Request: N/A




certificate_version String This property provides the certificate Version

from_city String This property provides certificate issuer city

from_common_name String This property provides the Certificate Issuer

common name

from_country String This property provides certificate issuer country

from_email_id String This property provides the Certificate issuer

email id

249

from_organization String This property provides certificate issuer

organization

from_organization_unit String This property provides the certificate issuer

organization unit

from_state String This property provides the certificate issuer

state

public_key String This property provides the public key of the

certificate

serial_number String This property provides the certificate serial

number

signature_algorithm String This property provides the certificates signature

algorithm

to_city String This property provides the to certificate issued

to city

to_common_name String This property provides the to common name

to_country String This property provides the to country

to_email_id String This property provides the to email id

to_organization String This property provides the to organization

to_organization_unit String This property provides the to organization unit

to_state String This property provides the to state

valid_from String This property provides the certificate validity

start date

valid_till String This property provides the certificate validity

end date

Example:

250

{

"certificate_version": "3",

"from_city": "Atlanta",

"from_common_name": "AMI",

"from_country": "US",

"from_email_id": "[email protected]",

"from_organization": "American Megatrends Inc",

"from_organization_unit": "Service Processors",

"from_state": "Georgia",

"id": 1,

"public_key": "",

"serial_number": "BD16DD20846F43A8",

"signature_algorithm": "sha1WithRSAEncryption",

"to_city": "Atlanta",

"to_common_name": "AMI",

"to_country": "US",

"to_email_id": "[email protected]",

"to_organization": "American Megatrends Inc",

"to_organization_unit": "Service Processors",

"to_state": "Georgia",

"valid_from": "Jul 28 06:47:29 2014 GMT",

"valid_till": "Jul 25 06:47:29 2024 GMT"

}

2.139 POST /api/operations/ssl/certificate/generate


Request: N/A



common_name String Common name for which the certificate is to be

generated

organization String Organization name for which certificate to be

generated.

251

organization_unit String Over all organization section unit name for

which certificate to be generated.

city String City or Locality has to be given

state String State or Province has to be given

country String Country code has to be given

email_id String Email Address of the organization has to be

given

valid_days Number Number of days the certificate to be validated.

Range (1-3650) Days

key_length Number Choose the key length bit value of the certificate

(512/1024)

Example:

Request

{

"common_name": "Testing",

"organization": "AMI",

"organization_unit":

"Megarac", "city": "Chennai",

"state": "TN",

"country": "IN",


"valid_days": 365,

"key_length": 512

}

Response:

{

"common_name": "Testing",

"organization": "AMI",

"organization_unit":

"Megarac", "city": "Chennai",

"state": "TN",

252

"country": "IN",


"valid_days": 365,

"key_length": 512

}

2.140 GET api/settings/video/sol-remote-storage

Description: RetriewSOL Remote Storage configurations

Request: N/A




remote_support Number This property provides the enable /disable

remote support

Enable (1)

Disable (0)

NOTE: By default, video files will be stored in

local path of BMC. If remote video support is

enabled, then the video files will be stored only

in remote path, not within BMC.

mount_status String This property provides the mount status

ip_address String This property provides the ip address value

remote_path String This property provides the remote server path

share_type String This property provides the share type

NFS CIFS

user_name String This property provides the User Name

password String This property provides the Password

253

domain_name String This property provides the domain name

log_size Number This property provides the log size. Range (1-

256)

log_file_count Number This property provides the log file counts. Rang

(1-10)

Example:

{

}

"id": 1,


"mount_status": -1,

"ip_address": "",

"remote_path": "",


"user_name": "",

"password": "",

"domain_name": "",

"log_size": 128,

"log_file_count": 1

2.141 POST api/settings/video/sol-remote-storage

Description: Set SOL Remote Storage configurations

Request:



remote_support Number This property provides the enable /disable remote

support

Enable (1)

Disable (0)

254


255




NFS CIFS




log_size Number This property provides the log size. Range (1-256)


(1-10)




remote_support Number This property provides the enable /disable

remote support

Enable (1)

Disable (0)





NFS CIFS

256




log_size Number This property provides the log size. Range (1-

256)


(1-10)

Example:

{

}

"id": 1,


"mount_status": -1,

"ip_address": "",

"remote_path": "",


"user_name": "",

"password": "",

"domain_name": "",

"log_size": 128,

"log_file_count": 1

2.142 GET api/settings/video/sol-triggers

Description: Retrieve SOL trigger configurations

Request: N/A




257

critical_events_enable Number This property provides the enable /disable critical

events

Enable (1)

Disable (0)

non_critical_events_enable Number This property provides the enable /disable non

critical events

Enable (1)

Disable (0)

non_recoverable_events_enable Number This property provides the enable /disable non

recoverable events

Enable (1)

Disable (0)

fan_state_events_enable Number This property provides the enable /disable fan

state events

Enable (1)

Disable (0)

watchdog_events_enable Number This property provides the enable /disable

watchdog events

Enable (1)

Disable (0)

chasis_power_on_events_enable Number This property provides the enable /disable chasis

power on events

Enable (1)

Disable (0)

chasis_power_off_events_enable Number This property provides the enable /disable chasis

power off events

258

chasis_reset_events_enable Number This property provides the enable /disable chasis

reset events

Enable (1)

Disable (0)

lpc_reset_events_enable Number This property provides the enable /disable lpc

reset events

Enable (1)

Disable (0)

date_time_events_enable Number This property provides the enable /disable date

time events

Enable (1)

Disable (0)

date_time_to_record Number This property provides the date time to record

logs

Enable (1)

Disable (0)

Example:

{

"id": 1,






"chasis_power_on_events_enable": 0,

"chasis_power_off_events_enable": 0,

"chasis_reset_events_enable": 0,



"date_time_to_record": 0

259

}

2.143 PUT api/settings/video/sol-triggers

Description: Retrieve SOL trigger configurations

Request:



critical_events_enable Number This property provides the enable /disable critical

events

Enable (1)

Disable (0)


critical events

Enable (1)

Disable (0)


recoverable events

Enable (1)

Disable (0)


state events

Enable (1)

Disable (0)


watchdog events

Enable (1)

Disable (0)

260


power on events

Enable (1)

Disable (0)


power off events


reset events

Enable (1)

Disable (0)


reset events

Enable (1)

Disable (0)


time events

Enable (1)

Disable (0)

date_time_to_record Number This property provides the date time to record

logs

Enable (1)

Disable (0)




261

critical_events_enable Number This property provides the enable /disable

critical events

Enable (1)

Disable (0)


critical events

Enable (1)

Disable (0)


recoverable events

Enable (1)

Disable (0)


state events

Enable (1)

Disable (0)


watchdog events

Enable (1)

Disable (0)


power on events

Enable (1)

Disable (0)


power off events

260


reset events

Enable (1)

Disable (0)


reset events

Enable (1)

Disable (0)


time events

Enable (1)

Disable (0)

date_time_to_record Number Timestamp for date and time to record

NTPtimestamp Number Timestamp for log creation date

Example:

Request:

{

"id": 1,












"NTPtimestamp": 1515633829

262

}

Response:

{

"id": 1,












"NTPtimestamp": 1515633829

}

2.144 GET api/configuration/runtime

Description: Retrieve runtime configuration

Request: N/A



Feature String This property provides the feature name

Enable Number This property provides the feature enable /disable

Enable (1)

Disable (0)

Example:

[ {

"feature": "LDAP",

"enabled": 1

}]

263

2.145 GET api/chassis-status

Description: Retrieve chassis status

Request: N/A



power_status Number This property provides the power status

On (1)

Off (0)

led_status Number This property provides the led status

On (1)

Off (0)

Example:

[{

"power_status": 0,

"led_status": 0

}]

2.146 GET api/firmware-info

Description: Retrieve Firmware Information

Request: N/A



device_id Number This property provides the Device Id

Revision Number This property provides the firmware revision

fw_rev_1 Number This property provides the firmware revision 1

fw_rev_2 Number This property provides the firmware revision 2

264

ipmi_version Number This property provides the ipmi version

dev_support Number This property provides the development support

mfg_id_0 Number This property provides the MFG Id 0



prod_id Number This property provides the product Id

Aux Number This property provides the aux number

fw_ver String This property provides the firmware version

Date String This property provides the firmware date

Time String This property provides the firmware time

active_image Number This property provides the active image number

Example:

{

"device_id": 32,

"revision": 1,

"fw_rev_1": 2,

"fw_rev_2": 3,

"ipmi_version": 2,

"dev_support": 191,

"mfg_id_0": 0,

"mfg_id_1": 0,

"mfg_id_2": 0,

"prod_id": 514,

"aux": 89271,

"fw_ver": "2.03.89271",

"date": "Mar 10 2016",

"time": "19:31:07 EDT",

"active_image": 0

265

}

2.147 GET api/maintenance/restore_defaults

Description: Retrieve Restore Default configuration

Request: N/A


266



Sdr Number This property provides the preserved status of

SDR configuration

preserved (1)

not preserved (0)

Fru Number This property provides the preserved status of

FRU configuration.

preserved (1)

not preserved (0)

Sel Number This property provides the preserved status of

SEL configuration.

preserved (1)

not preserved (0)

Ipmi Number This property provides the preserved status of

IPMI configuration.

preserved (1)

not preserved (0)

network Number This property provides the preserved status of

Network configuration.

preserved (1)

not preserved (0)

Ntp Number This property provides the preserved status of

NTP configuration.

preserved (1)

not preserved (0)

267

snmp Number This property provides the preserved status of

SNMP

preserved (1)

not preserved (0)

Ssh Number This property provides the preserved status of

SSH configuration.

preserved (1)

not preserved (0)

Kvm Number This property provides the preserved status of

KVM configuration.

preserved (1)

not preserved (0)

authentication Number This property provides the preserved status of

authentication configuration.

preserved (1)

not preserved (0)

syslog Number This property provides the preserved status of

syslog configuration.

preserved (1)

not preserved (0)

Example:

{

"id": 1,

"sdr": 0,

"fru": 0,

"sel": 0,

"ipmi": 0,

"network": 0,

"ntp": 0,

268

"snmp": 0,

"ssh": 0,

"kvm": 0,


"syslog": 0

}

2.148 PUT api/maintenance/restore_defaults

Description: Set Restore Default configuration

Request:




SDR configuration

preserved (1)

not preserved (0)


FRU configuration.

preserved (1)

not preserved (0)


SEL configuration.

preserved (1)

not preserved (0)


IPMI configuration.

preserved (1)

not preserved (0)

269



preserved (1)

not preserved (0)


NTP configuration.

preserved (1)

not preserved (0)

Snmp Number This property provides the preserved status of

SNMP

preserved (1)

not preserved (0)


SSH configuration.

preserved (1)

not preserved (0)


KVM configuration.

preserved (1)

not preserved (0)



preserved (1)

not preserved (0)



270

preserved (1)

not preserved (0)





SDR configuration

preserved (1)

not preserved (0)


FRU configuration.

preserved (1)

not preserved (0)


SEL configuration.

preserved (1)

not preserved (0)


IPMI configuration.

preserved (1)

not preserved (0)



preserved (1)

not preserved (0)

271


NTP configuration.

preserved (1)

not preserved (0)

snmp Number This property provides the preserved status of

SNMP

preserved (1)

not preserved (0)


SSH configuration.

preserved (1)

not preserved (0)


KVM configuration.

preserved (1)

not preserved (0)



preserved (1)

not preserved (0)



preserved (1)

not preserved (0)

Example:

{

"id": 1,

272

"sdr": 0,

"fru": 0,

"sel": 0,

"ipmi": 0,

"network": 0,

"ntp": 0,

"snmp": 0,

"ssh": 0,

"kvm": 0,


"syslog": 0

}

2.149 GET api/scripts

Description: Retrieve Automation Engine scripts

Request: N/A





http

tftp




Example:

{

"id": 1,



273


"retry_count": 3

}

2.150 POST /api/settings/ldap-certificates

Description: To Upload Ceritificates for LDAP startTLS

Request:


ca_certificate_file File File that contains the certificate of

the trusted CA certs.

CA certificate file should be of the type pem

certificate_file File Client certificate filename.

Certificate File should be of the type pem

private_key File This property provides the Client

private key filename.

Private Key should be of the type pem

NOTE: All of the 3 files are

required when StartTLS enabled.




Example:

Request: File upload

Response:

{cc : 0}

2.151 POST /api/settings/media/remote/start-media

Description: Request to start remote media redirection

274

Request:


image_type Number This property provides the Image Type

image_index Number This property provides the Image Index

image_name String This property provides the Image Name



image_type Number This property provides the Image Type



Example:

Request:

{

}

"image_name": "cdiso.iso",

"image_type": 1,

"image_index": 0

Response:

{


"image_type": 1,

"image_index": 0

}

2.152 POST /api/settings/media/remote/stop-media

Description: Request to stop remote media redirection

Request:


275

image_type Number This property provides the Image type of the image

to be stopped





image_type Number This property provides the Image Type which has

been stopped

image_index Number This property provides the Image Index which has

been stopped

image_name String This property provides the Image Name which has

been stopped

Example:

Request:

{

}


"image_type": 1,

"image_index": 0

Response:

{


"image_type": 1,

"image_index": 0

}

2.153 POST /api/maintenance/upload_restore

Description: To upload the restore configuration file.

Request: Restore config “.bak” file should be uploaded

Response:

276



Success(0)

Example:

Request:

{

}

cc:0

Documents

API Reference Guide v0.1 Reference Guide... · 2020. 4. 13. · 8 1 Introduction MegaRAC® SP-X is a powerful server management solution composed of firmware and software components