actionCustomParamSpecs
  • Description: Identifies the specifications for custom parameters that are included as part of the custom action.
  • Type: Sequence of custom action parameters

    paramName
    • Description: Identifies the name for this parameter.
    • Type: String
    displayName
    • DescriptionA descriptive name for this CloudCenter resource.
    • Type: String
    helpText
    • Description: The additional information provided for this parameter.
    • Type: String
    type
    • Description: The type of parameter used for this specification. See the Parameter Type section for the relevant release for additional details.

    • Type: Enumeration

      API EnumerationCCM UI Listing
      stringstring
      numbernumber
      listlist
      webservicewebservice
      password_input password with confirmation
      passwordpassword
      pathpath
      textarea
      textarea
      secretsecret key (Effective CloudCenter 4.9.0)
    valueList
    • Description: A list of comma separated values (limited to 255 characters). See the Parameter Type section for the relevant release for additional details.
    • Type: String
    defaultValue
    • Description: The default value for this service parameter
    • Type: String
     confirmValue 
    • Description: In case you provide a password input type parameter, this attribute confirms the password value.
    • Type: String
     pathSuffixValue 
    • Description: The value for the path (text that encodes a URL) type parameter.
    • Type: String
    userVisible
    • Description: Identifies if a service parameter is visible all users in the tenant
      • true = Parameter is visible to all users
      • false = Parameter is not visible to all users (just the admin)
    • Type: Boolean
    userEditable
    • Description: Identifies if a user is allowed to edit this service parameter:
      • true = Can change the preset values for this parameter
      • false = Cannot change the preset values for this parameter
    • Type: Boolean
    systemParam
    • Description: Identifies if this parameter is provided by the CloudCenter platform:
      • true = Provided by the CloudCenter platform
      • false = Added by the user or derived through another source
    • Type: Boolean
    exampleValue
    • Description: Identifies an example for this service parameter value
    • Type: String
    dataUnit
    • Description: Not Used... 
    • Type: String
    optional
    • Description: Identifies if this parameter is required for this service:
      • true = This parameter is required for this service
      • false = This parameter is optional for this service
    • Type: Boolean
     multiselectSupported  
    • Description: Identifies if a list for a custom parameter allows the end user to select multiple items in the list.
    • Type: String
    valueConstraint
    • Description: Identifies the  value restrictions for parameters created using the CloudCenter platform  
    • Type: Array of mapped attributes

      minValue
      • Description: The minimum required parameter value
      • Type: Integer
      maxValue
      • Description: The maximum allowed parameter value
      • Type: Integer
      regex
      • Description: Identifies if this parameter should be a regular expression
      • Type: String
      allowSpaces
      • Description: Identifies if spaces are allowed in the parameter name:
        • true = Spaces are allowed in the parameter name
        • false = Spaces are not allowed in the parameter name
      • Type: Boolean
      maxLength
      • Description: The maximum allowed length for this parameter name
      • Type: Integer
      sizeValue
      • Description: Identifies the size of this parameter
      • Type: Integer
      step
      • Description: Identifies the step for this parameter in the service execution process
      • Type: Integer
    scope
    • Description: Indicates the level at which you need to configure this value:

    • Type: Enumeration

      EnumerationDescription
      REGION

      Configure this value at the cloud region level

      USERConfigure this value at the user level
    webserviceListParams
    • Description: Provide a list of dynamic webservice parameters while deploying a job. From this list, users can select one parameter. The webservice parameter type is available in custom parameters, global parameters, and services. The output should be in the following format:
      [{"name":"p1",
      "displayName":"Param 1"},
       {"name":"p2",
        "displayName":"Param 2"}]

      If you configure this parameter type, you must provide the Protocol (HTTP or HTTPS), Web Service URL, and the credentials (Username and Password) for this webservice.

    • Type: Array of mapped attributes

      url
      • Description: The URL that is associated with the tenant's marketing website. See the Tenant ID and Tenant Name Dependency section for the relevant release for additional details.

        This is not the URL to access the CloudCenter platform

      • Type: String
      protocol
      • Description: Defines the protocol to be used by VMs running this service.
      • Type: Enumeration:

        ProtocolDescription
        TCPTransmission Control Protocol
        UDPUser Datagram Protocol
      username
      • Description: Unique, CloudCenter-generated name reference for this user.
      • Type: String
      password
      • Description: Password for the user's account. Effective Cloud Center 4.6.1, the CloudCenter platform enforces a minimum password length of 5 characters for all settings.
      • Type: String
       requestType 
       contentType 
       commandParams 
      • DescriptionIdentifies the query parameters for this call. See the Parameter Type section for the relevant release for additional context.
      • Type: String
       requestBody 
      • Description: Identifies the additional information sent in the request body for each request call.
      • Type: String
       resultString 
      • Type: String

     

  • No labels
Terms & Conditions Privacy Statement Cookies Trademarks