Jump to

• Request
• Response

Modify This Admin Virtual Target

post

/management/weblogic/{version}/edit/partitions/{name}/adminVirtualTarget

Modify this admin virtual target.

Request

Supported Media Types

• application/json

Path Parameters

• name: string
  The name property of the instance in the collection.
• version: string
  The version of the WebLogic REST interface.

Header Parameters

• X-Requested-By: string
  The 'X-Requested-By' header is used to protect against Cross-Site Request Forgery (CSRF) attacks. The value is an arbitrary name such as 'MyClient'.

Body ()

Must contain the modified admin virtual target model.

Root Schema : Admin Virtual Target

Type: object

Show Source

• deploymentOrder(optional): integer(int32)
  Minimum Value: 0

  Maximum Value: 2147483647

  Default Value: 1000

  A priority that the server uses to determine when it deploys an item. The priority is relative to other deployable items of the same type.

  For example, the server prioritizes and deploys all EJBs before it prioritizes and deploys startup classes.

  Items with the lowest Deployment Order value are deployed first. There is no guarantee on the order of deployments with equal Deployment Order values. There is no guarantee of ordering across clusters.

• dynamicallyCreated(optional): boolean
  Read Only: true

  Default Value: false

  Return whether the MBean was created dynamically or is persisted to config.xml

• explicitPort(optional): integer(int32)
  Minimum Value: 0

  Maximum Value: 65535

  Default Value: 0

  Get the explicit port for this virtual target.

• hostNames(optional): array Items
  Title: Items

  Host names, separated by line breaks, for which this virtual target will serve requests.

• id(optional): integer(int64)
  Read Only: true

  Return the unique id of this MBean instance

• name(optional): string
  Read Only: true

  The user-specified name of this MBean instance.

  This name is included as one of the key properties in the MBean's javax.management.ObjectName

  Name=user-specified-name

  Constraints

  • legal null
• notes(optional): string

  Optional information that you can include to describe this configuration.

  WebLogic Server saves this note in the domain's configuration file (config.xml) as XML PCDATA. All left angle brackets (<) are converted to the xml entity <. Carriage returns/line feeds are preserved.

  Note: If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.

• partitionChannel(optional): string
  Default Value: PartitionChannel

  The channel name to be used as a reference for creating a partition specific channel.

• portOffset(optional): integer(int32)
  Minimum Value: 0

  Maximum Value: 65535

  Default Value: 0

  The port offset for this virtual target. If set to the minimum value, the port offset is not set.

• tags(optional): array Items
  Title: Items

  Return all tags on this Configuration MBean

• targets(optional): array Target References
  Title: Target References

  Contains the array of target references.

  You must select a target from this list of the targets in the current domain. Targets must be either servers or clusters. The deployment will only occur once if the targets overlap. For example, if a deployment is deployed both on a cluster C and on a server S that is a member of that cluster, the deployment will be deployed on server S only once.

  Constraints

  • restart required
• type(optional): string
  Read Only: true

  Returns the type of the MBean.

  Constraints

  • unharvestable
• uriPrefix(optional): string
  Default Value: /

  The URI prefix for this virtual target.

{
    "type":"object",
    "properties":{
        "deploymentOrder":{
            "default":1000,
            "minimum":0,
            "maximum":2147483647,
            "type":"integer",
            "format":"int32",
            "description":"<p>A priority that the server uses to determine when it deploys an item. The priority is relative to other deployable items of the same type.</p><p>For example, the server prioritizes and deploys all EJBs before it prioritizes and deploys startup classes.</p><p>Items with the lowest Deployment Order value are deployed first. There is no guarantee on the order of deployments with equal Deployment Order values. There is no guarantee of ordering across clusters.</p>"
        },
        "dynamicallyCreated":{
            "readOnly":true,
            "default":false,
            "type":"boolean",
            "description":"<p>Return whether the MBean was created dynamically or is persisted to config.xml</p>"
        },
        "explicitPort":{
            "default":0,
            "minimum":0,
            "maximum":65535,
            "type":"integer",
            "format":"int32",
            "description":"<p>Get the explicit port for this virtual target.</p>"
        },
        "hostNames":{
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>Host names, separated by line breaks, for which this virtual target will serve requests.</p>"
        },
        "id":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Return the unique id of this MBean instance</p>"
        },
        "name":{
            "readOnly":true,
            "x-weblogic-legalNull":true,
            "type":"string",
            "description":"<p>The user-specified name of this MBean instance.</p><p>This name is included as one of the key properties in the MBean's <code>javax.management.ObjectName</code></p><p><code>Name=<i>user-specified-name</i></code></p><p><h5>Constraints</h5></p><ul><li>legal null</li></ul>"
        },
        "notes":{
            "type":"string",
            "description":"<p>Optional information that you can include to describe this configuration.</p><p>WebLogic Server saves this note in the domain's configuration file (<code>config.xml</code>) as XML PCDATA. All left angle brackets (<) are converted to the XML entity <code>&lt;</code>. Carriage returns/line feeds are preserved.</p><p>Note: If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.</p>"
        },
        "partitionChannel":{
            "default":"PartitionChannel",
            "type":"string",
            "description":"<p>The channel name to be used as a reference for creating a partition specific channel.</p>"
        },
        "portOffset":{
            "default":0,
            "minimum":0,
            "maximum":65535,
            "type":"integer",
            "format":"int32",
            "description":"<p>The port offset for this virtual target. If set to the minimum value, the port offset is not set.</p>"
        },
        "tags":{
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>Return all tags on this Configuration MBean</p>"
        },
        "targets":{
            "x-weblogic-restartRequired":true,
            "title":"Target References",
            "type":"array",
            "items":{
                "title":"Target Reference",
                "type":"object",
                "properties":{
                    "identity":{
                        "title":"Identity",
                        "type":"array",
                        "items":{
                            "type":"string",
                            "description":""
                        },
                        "description":"DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource."
                    }
                },
                "description":"Contains the target reference."
            },
            "description":"Contains the array of target references. <p>You must select a target from this list of the targets in the current domain. Targets must be either servers or clusters. The deployment will only occur once if the targets overlap. For example, if a deployment is deployed both on a cluster C and on a server S that is a member of that cluster, the deployment will be deployed on server S only once.</p><p><h5>Constraints</h5></p><ul><li>restart required</li></ul>"
        },
        "type":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>Returns the type of the MBean.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        },
        "uriPrefix":{
            "default":"/",
            "type":"string",
            "description":"<p>The URI prefix for this virtual target.</p>"
        }
    },
    "description":""
}

Nested Schema : Items

Type: array

Title: Items

Host names, separated by line breaks, for which this virtual target will serve requests.

Show Source

• Array of: string

{
    "title":"Items",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"<p>Host names, separated by line breaks, for which this virtual target will serve requests.</p>"
}

Nested Schema : Items

Type: array

Title: Items

Return all tags on this Configuration MBean

Show Source

• Array of: string

{
    "title":"Items",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"<p>Return all tags on this Configuration MBean</p>"
}

Nested Schema : Target References

Type: array

Title: Target References

Contains the array of target references.

You must select a target from this list of the targets in the current domain. Targets must be either servers or clusters. The deployment will only occur once if the targets overlap. For example, if a deployment is deployed both on a cluster C and on a server S that is a member of that cluster, the deployment will be deployed on server S only once.

Constraints

• restart required

Show Source

• Array of: object Target Reference
  Title: Target Reference

  Contains the target reference.

{
    "x-weblogic-restartRequired":true,
    "title":"Target References",
    "type":"array",
    "items":{
        "title":"Target Reference",
        "type":"object",
        "properties":{
            "identity":{
                "title":"Identity",
                "type":"array",
                "items":{
                    "type":"string",
                    "description":""
                },
                "description":"DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource."
            }
        },
        "description":"Contains the target reference."
    },
    "description":"Contains the array of target references. <p>You must select a target from this list of the targets in the current domain. Targets must be either servers or clusters. The deployment will only occur once if the targets overlap. For example, if a deployment is deployed both on a cluster C and on a server S that is a member of that cluster, the deployment will be deployed on server S only once.</p><p><h5>Constraints</h5></p><ul><li>restart required</li></ul>"
}

Nested Schema : Target Reference

Type: object

Title: Target Reference

Contains the target reference.

Show Source

• identity(optional): array Identity
  Title: Identity

  DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource.

{
    "title":"Target Reference",
    "type":"object",
    "properties":{
        "identity":{
            "title":"Identity",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource."
        }
    },
    "description":"Contains the target reference."
}

Nested Schema : Identity

Type: array

Title: Identity

DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource.

Show Source

• Array of: string

{
    "title":"Identity",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource."
}

Security

• Admin: basic
  Type: basic

  Description: A user in the Admin security role.

Back to Top

Response

200 Response

Back to Top