Amster

GeneralProperties

Global Operations

An object of property key-value pairs

Resource path:

/global-config/servers/{serverName}/properties/general

Resource version: 1.0

read

Usage

am> read GeneralProperties --global --serverName serverName

Parameters

--serverName

An object of property key-value pairs

update

Usage

am> update GeneralProperties --global --serverName serverName --body body

Parameters

--serverName

An object of property key-value pairs

--body

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

{
  "type" : "object",
  "properties" : {
    "amconfig.header.site" : {
      "title" : "Site",
      "type" : "object",
      "propertyOrder" : 0,
      "properties" : {
        "singleChoiceSite" : {
          "enum" : null,
          "options" : {
            "enum_titles" : null
          },
          "type" : "string",
          "title" : "Parent Site",
          "propertyOrder" : 0,
          "required" : false,
          "description" : "Parent Site"
        }
      }
    },
    "amconfig.header.installdir" : {
      "title" : "System",
      "type" : "object",
      "propertyOrder" : 1,
      "properties" : {
        "com.iplanet.services.configpath" : {
          "title" : "Base installation directory",
          "type" : "object",
          "propertyOrder" : 0,
          "description" : "Base directory where product's data resides. (property name: com.iplanet.services.configpath)",
          "properties" : {
            "value" : {
              "type" : "string",
              "required" : false
            },
            "inherited" : {
              "type" : "boolean",
              "required" : true
            }
          }
        },
        "com.iplanet.am.locale" : {
          "title" : "Default Locale",
          "type" : "object",
          "propertyOrder" : 1,
          "description" : "Default locale for the product. (property name: com.iplanet.am.locale)",
          "properties" : {
            "value" : {
              "type" : "string",
              "required" : false
            },
            "inherited" : {
              "type" : "boolean",
              "required" : true
            }
          }
        },
        "com.sun.identity.client.notification.url" : {
          "title" : "Notification URL",
          "type" : "object",
          "propertyOrder" : 2,
          "description" : "The location of notification service end point. It is usually the product's deployment URI/notificationservice. (property name: com.sun.identity.client.notification.url)",
          "properties" : {
            "value" : {
              "type" : "string",
              "required" : false
            },
            "inherited" : {
              "type" : "boolean",
              "required" : true
            }
          }
        },
        "com.iplanet.am.util.xml.validating" : {
          "title" : "XML Validation",
          "type" : "object",
          "propertyOrder" : 3,
          "description" : "Specifies if validation is required when parsing XML documents. (property name: com.iplanet.am.util.xml.validating)",
          "properties" : {
            "value" : {
              "enum" : [ "on", "off" ],
              "options" : {
                "enum_titles" : [ "On", "Off" ]
              },
              "type" : "string",
              "required" : false
            },
            "inherited" : {
              "type" : "boolean",
              "required" : true
            }
          }
        }
      }
    },
    "amconfig.header.debug" : {
      "title" : "Debugging",
      "type" : "object",
      "propertyOrder" : 2,
      "properties" : {
        "com.iplanet.services.debug.level" : {
          "title" : "Debug Level",
          "type" : "object",
          "propertyOrder" : 0,
          "description" : "Debug level for all components in the product. (property name: com.iplanet.services.debug.level)",
          "properties" : {
            "value" : {
              "enum" : [ "off", "error", "warning", "message" ],
              "options" : {
                "enum_titles" : [ "Off", "Error", "Warning", "Message" ]
              },
              "type" : "string",
              "required" : false
            },
            "inherited" : {
              "type" : "boolean",
              "required" : true
            }
          }
        },
        "com.sun.services.debug.mergeall" : {
          "title" : "Merge Debug Files",
          "type" : "object",
          "propertyOrder" : 1,
          "description" : "On : Directs all debug data to a single file (debug.out); Off : creates separate per-component debug files (property name : com.sun.services.debug.mergeall)",
          "properties" : {
            "value" : {
              "enum" : [ "on", "off" ],
              "options" : {
                "enum_titles" : [ "On", "Off" ]
              },
              "type" : "string",
              "required" : false
            },
            "inherited" : {
              "type" : "boolean",
              "required" : true
            }
          }
        },
        "com.iplanet.services.debug.directory" : {
          "title" : "Debug Directory",
          "type" : "object",
          "propertyOrder" : 2,
          "description" : "Directory where debug files reside. (property name: com.iplanet.services.debug.directory)",
          "properties" : {
            "value" : {
              "type" : "string",
              "required" : false
            },
            "inherited" : {
              "type" : "boolean",
              "required" : true
            }
          }
        }
      }
    },
    "amconfig.header.mailserver" : {
      "title" : "Mail Server",
      "type" : "object",
      "propertyOrder" : 3,
      "properties" : {
        "com.iplanet.am.smtphost" : {
          "title" : "Mail Server Host Name",
          "type" : "object",
          "propertyOrder" : 0,
          "description" : "(property name: com.iplanet.am.smtphost)",
          "properties" : {
            "value" : {
              "type" : "string",
              "required" : false
            },
            "inherited" : {
              "type" : "boolean",
              "required" : true
            }
          }
        },
        "com.iplanet.am.smtpport" : {
          "title" : "Mail Server Port Number",
          "type" : "object",
          "propertyOrder" : 1,
          "description" : "(property name: com.iplanet.am.smtpport)",
          "properties" : {
            "value" : {
              "type" : "integer",
              "required" : false
            },
            "inherited" : {
              "type" : "boolean",
              "required" : true
            }
          }
        }
      }
    }
  }
}
Copyright © 2010-2023 ForgeRock, all rights reserved.