GET A Create Form For This Migratable Target Collection
/management/weblogic/{version}/edit/migratableTargetCreateForm
This resource returns a pre-populated migratable target model that can be customized then posted (using the POST method) to the migratableTargets collection resource to create a new migratable target.
Request
-
version: string
The version of the WebLogic REST interface.
-
excludeFields(optional): string
The 'excludeFields' query parameter is used to restrict which fields are returned in the response. It is a comma separated list of field names. If present, only fields whose name is not on the list will be returned. If not present, all fields are returned (unless the 'fields' query parameter is specified). Note: 'fields' must not be specified if 'excludeFields' is specified.
-
excludeLinks(optional): string
The 'excludeLinks' query parameter is used to restrict which links are returned in the response. It is a comma separated list of link relationship names. If present, only links whose relationship name is not on the list will be returned. If not present, all links are returned (unless the 'links' query parameter is specified). Note: 'links' must not be specified if 'excludeLinks' is specified.
-
fields(optional): string
The 'fields' query parameter is used to restrict which fields are returned in the response. It is a comma separated list of field names. If present, only fields with matching names are returned. If not present, all fields are returned (unless the 'excludeFields' query parameter is specified). Note: 'excludeFields' must not be specified if 'fields' is specified.
-
links(optional): string
The 'links' query parameter is used to restrict which links are returned in the response. It is a comma separated list of link relationship names. If present, only links with matching relationship names are returned. If not present, all links are returned (unless the 'excludeLinks' query parameter is specified). Note: 'excludeLinks' must not be specified if 'links' is specified.
-
Admin: basic
Type:
basic
Description:A user in the Admin security role.
-
Deployer: basic
Type:
basic
Description:A user in the Deployer security role.
-
Monitor: basic
Type:
basic
Description:A user in the Monitor security role.
-
Operator: basic
Type:
basic
Description:A user in the Operator security role.
Response
- application/json
200 Response
Returns this migratable target.
This method can return the following links:
- rel=create uri=/management/weblogic/{version}/edit/migratableTargets
The collection resource for this create form resource.
object
-
additionalMigrationAttempts(optional):
integer(int32)
Default Value:
2
A migratable service could fail to come up on every possible configured server. This attribute controls how many further attempts, after the service has failed on every server at least once, should be tried. Note that each attempt specified here indicates another full circuit of migrations amongst all the configured servers. So for a 3-server cluster, and a value of 2, a total of 4 additional migrations will be attempted. (the original server is never a valid destination)
-
allCandidateServers(optional):
array Server References
Title:
Server References
Contains the array of server references.The list of servers that are candidates to host the migratable services deployed to this migratable target. If the constrainedCandidateServers list is empty, all servers in the cluster are returned. If the constrainedCandidateServers list is not empty, only those servers will be returned. The user-preferred server will be the first element in the list.
-
cluster(optional):
array Cluster Reference
Title:
Cluster Reference
Contains the cluster reference.Returns the cluster this singleton service is associated with.
Constraints
- restart required
-
constrainedCandidateServers(optional):
array Server References
Title:
Server References
Contains the array of server references.The (user-restricted) list of servers that can host the migratable services deployed to this migratable target. The migratable service will not be allowed to migrate to a server that is not in the returned list of servers.
For example, this feature may be used to configure two servers that have access to a dual-ported ported disk. All servers in this list must be part of the cluster that is associated with the migratable target.
Constraints
- restart required
-
critical(optional):
boolean
Default Value:
false
Returns true if the MigratableTarget is critical to the overall health of the WLS Server
-
dynamicallyCreated(optional):
boolean
Read Only:
true
Default Value:false
Return whether the MBean was created dynamically or is persisted to config.xml
-
hostingServer(optional):
array Server Reference
Title:
Server Reference
Read Only:true
Contains the server reference.Returns the name of the server that currently hosts the singleton service.
-
id(optional):
integer(int64)
Read Only:
true
Return the unique id of this MBean instance
-
migrationPolicy(optional):
string
Default Value:
manual
Allowed Values:[ "manual", "exactly-once", "failure-recovery", "shutdown-recovery" ]
Defines the type of migration policy to use for the services hosted by this migratable target. Valid options are:
Manual Service Migration Only
Indicates that no automatic migration of services hosted by this migratable target will occur.Auto-Migrate Exactly-Once Services
Indicates that if at least one Managed Server in the candidate server list is running, the services hosted by this migratable target will be active somewhere in the cluster if servers should fail or are administratively shut down (either gracefully or forcibly). For example, it is a recommended best practice to use this policy when a migratable target hosts a path service, so if its preferred server fails or is shut down, the path service will automatically migrate to another candidate server, and so will always be active in the cluster.Notes
This value can lead to target grouping on a server member. For example, if you have five exactly-once migratable targets and only one Managed Server is started in the cluster, then all five targets will be activated on that server.
This policy does not apply for JTA service migration.Auto-Migrate Failure-Recovery Services
Indicates that the services hosted by this migratable target will only start if the migratable target's User Preferred Server (UPS) is started. If an administrator manually shuts down the UPS, either gracefully or forcibly, then a failure-recovery service will not migrate. However, if the UPS fails due to an internal error, then the service will be migrated to another candidate server. If such a candidate server is unavailable (due to either a manual shutdown or an internal failure), then the migration framework will first attempt to reactivate the service on its UPS server. If the UPS server is not available at that time, then the service will be migrated to another candidate server.
-
millisToSleepBetweenAttempts(optional):
integer(int32)
Default Value:
300000
Controls how long of a pause there should be between the migration attempts described in getAdditionalMigrationAttempts(). Note that this delay only happens when the service has failed to come up on every server. It does not cause any sort of delay between attempts to migrate otherwise.
-
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
-
nonLocalPostAllowed(optional):
boolean
Default Value:
false
Specifies whether or not the post-deactivation script is allowed to run on a different machine.
Normally, when auto migration occurs, the post-deactivation script will be run on the service's current location, and the pre-activation script on the service's new location. If the current location is unreachable for some reason, this value will be checked to see if it is safe to run it on the service's new machine.
This is useful if the post-deactivation script controls access to a networked resource and does not need any data from the current machine.
-
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.
-
numberOfRestartAttempts(optional):
integer(int32)
Default Value:
6
Specifies how many restart attempts to make before migrating the failed service.
Note that these are consecutive attempts. If the value is set to 6, and the service restart fails 5 times before succeeding, but then fails again later, it will not instantly migrate. Each failure gets its own count of restart attempts.
A value of 0 is identical to setting getRestartOnFailure to false. A value of -1 indicates the service should never be migrated; instead, it will be restarted until it either works or the server shuts down.
-
postScript(optional):
string
Specifies the path to the post-migration script to run after a migratable target is fully deactivated. The script must be in the
MIDDLEWARE_HOME/user_projects/domains/mydomain/bin/service_migration
directory.After the migratable target is deactivated, if there is a script specified, and Node Manager is available, then the script will run. Specifying a script without an available Node Manager will result in an error upon migration.
-
postScriptFailureFatal(optional):
boolean
Default Value:
true
Specifies whether or not a failure during execution of the post-deactivation script is fatal to the migration.
If it is fatal, the migratable target will not be automatically migrated until an administrator manually migrates it to a server, thus reactivating it.
Note: Enabling this value will result in weakening the exactly-once guarantee. It is provided to prevent more dangerous data corruption if the post-deactivation script fails. Also if this value is enabled, then the script may be called more than once by the migration framework after the Migratable Target is deactivated or the server or machine hosting the Migratable Target crashed or is network partitioned. The script is expected not to return different exit values when invoked multiple times in such scenarios.
-
preScript(optional):
string
Specifies the path to the pre-migration script to run before a migratable target is actually activated. The script must be in the
MIDDLEWARE_HOME/user_projects/domains/mydomain/bin/service_migration
directory.Before the migratable target is activated, if there is a script specified, and Node Manager is available, then the script will run. Specifying a script without an available Node Manager will result in an error upon migration.
If the script fails or cannot be found, migration will not proceed on the current server, and will be tried on the next suitable server. This could be the next server in the candidate server list, or in the cluster, if there is no candidate server list.
-
restartOnFailure(optional):
boolean
Default Value:
false
Specifies whether or not a failed service will first be deactivated and reactivated in place, instead of being migrated.
The number of restart attempts is controlled by getNumberOfRestartAttempts. Once these restart attempts are exhausted, the service will migrate. A restarting migratable target will deactivate all services on it in order, then reactivate them all.
-
secondsBetweenRestarts(optional):
integer(int32)
Default Value:
30
Specifies how many seconds to wait in between attempts to restart the failed service.
-
tags(optional):
array Items
Title:
Items
Return all tags on this Configuration MBean
-
type(optional):
string
Read Only:
true
Returns the type of the MBean.
Constraints
- unharvestable
-
userPreferredServer(optional):
array Server Reference
Title:
Server Reference
Contains the server reference.Returns the server that the user prefers the singleton service to be active on.
array
Server References
The list of servers that are candidates to host the migratable services deployed to this migratable target. If the constrainedCandidateServers list is empty, all servers in the cluster are returned. If the constrainedCandidateServers list is not empty, only those servers will be returned. The user-preferred server will be the first element in the list.
-
Array of:
object Server Reference
Title:
Server Reference
Contains the server reference.
array
Cluster Reference
Returns the cluster this singleton service is associated with.
Constraints
- restart required
array
Server References
The (user-restricted) list of servers that can host the migratable services deployed to this migratable target. The migratable service will not be allowed to migrate to a server that is not in the returned list of servers.
For example, this feature may be used to configure two servers that have access to a dual-ported ported disk. All servers in this list must be part of the cluster that is associated with the migratable target.
Constraints
- restart required
-
Array of:
object Server Reference
Title:
Server Reference
Contains the server reference.
array
Server Reference
true
Returns the name of the server that currently hosts the singleton service.
array
Server Reference
Returns the server that the user prefers the singleton service to be active on.
object
Server Reference
-
identity(optional):
array Identity
Title:
Identity
DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource.
array
Identity
object
Server Reference
-
identity(optional):
array Identity
Title:
Identity
DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource.
array
Identity