PATCH /api/lunasa/services/{serviceid}

PATCH /api/lunasa/services/{serviceid}

Modifies the service attributes.

User Privileges

Users with the following role privileges can perform this command:

• admin
• operator

Parameters

serviceid

The identifier of the service of interest. Valid Values: cbs, lsta, network, ntls, ntp, syslog, snmp, ssh, stc, sysstat, webserver, cluster, ismigration, ctc, clusteradmin.

Use: Required

JSON Schema:

   Object
   type: string
    minLength: 1
    maxLength: 32
    pattern: ^[a-zA-Z0-9_.-]+$

onBoot

This parameter specifies the onBoot option for the service.

Use: Required

JSON Schema:

    Object
    type:boolean

Responses

200

Success

400

FRAMEWORK_BAD_REQUEST

Returned when the input data does not conform to the required validation schema.

APPLIANCE_FAILED_TO_MODIFY_SERVICE_INFO

Unexpected error

404

APPLIANCE_SERVICE_DOES_NOT_EXIST

Service does not exist

Example Request

   PATCH
   https://1.2.3.4:8443/api/lunasa/services/stc
   {
      "onBoot" : true
   }

Example Result

    {

    }

Notes

For ctc service, it will enable/disable the service for the active interfaces.