Servers

Global Operations

Servers resource provider is responsible for managing Servers and their configuration for an OpenAM instance.

Resource path: /global-config/servers

Resource version: 1.0

clone

Clone the specified Server, keeping it's settings but using a different URL.

Usage:

am> action Servers --global --body body --actionName clone

Parameters:

--body

The resource in JSON format, described by the following JSON schema:

{
  "$schema" : "http://json-schema.org/draft-04/schema#",
  "description" : "Container for required data to clone a Server.",
  "type" : "object",
  "title" : "Clone Server Request schema",
  "properties" : {
    "clonedUrl" : {
      "type" : "string",
      "title" : "Cloned Server URL",
      "description" : "The new URL of the cloned server. Must be unique."
    }
  }
}

create

Create a Server.

Usage:

am> create Servers --global --id id --body body

Parameters:

--id

The unique identifier for the resource.

--body

The resource in JSON format, described by the following JSON schema:

{
  "$schema" : "http://json-schema.org/draft-04/schema#",
  "description" : "Describes the data that a Server Resource could contain.",
  "type" : "object",
  "title" : "Server resource schema",
  "properties" : {
    "_id" : {
      "type" : "string",
      "title" : "Server id",
      "description" : "Unique identifier of the Server."
    },
    "siteName" : {
      "type" : "string",
      "title" : "Site name",
      "description" : "The Server's name."
    },
    "url" : {
      "type" : "string",
      "title" : "Url",
      "description" : "The URL of the Server."
    }
  }
}

delete

Delete a Server.

Usage:

am> delete Servers --global --id id

Parameters:

--id: The unique identifier for the resource.

query

Query the collection of the Servers.

Usage:

am> query Servers --global --filter filter

Parameters:

--filter: A CREST formatted query filter, where "true" will query all. Fields that can be queried: [*]

read

Read a Server.

Usage:

am> read Servers --global --id id

Parameters:

--id: The unique identifier for the resource.