The SMS_MigrationJob Windows Management Instrumentation (WMI) class is an SMS Provider server class, in Configuration Manager, that represents a migration job.
The following syntax is simplified from Managed Object Format (MOF) code and includes all inherited properties.
Class SMS_MigrationJob : SMS_BaseClass { String AdditionalConfiguration; String CreatedBy; String CustomBootImagePackage_x64; String CustomBootImagePackage_x86; DateTime DateCreated; DateTime DateEnded; DateTime DateLastUpdated; DateTime DateNextRun; DateTime DateStarted; String Description; String DestinationSiteCode; String DestinationSiteFQDN; Boolean DisableAdvertisements; UInt32 FailedObjectNumber; UInt32 JobID; String JobName; UInt32 MigratedObjectNumber; Boolean MigrateWithFolders; String ModifiedBy; UInt32 ResolveObjectConflictOption; String ScheduleToken; String ScopeIDs[]; UInt32 SkippedObjectNumber; String SourceCollectionIDs[]; UInt32 SourceObjectIDs[]; String SourceSiteCode; String SourceSiteFQDN; UInt32 SourceSiteID; UInt32 Status; UInt32 TotalObjectNumber; UInt32 Type; }; |
Methods
The following table lists the methods in the SMS_MigrationJob class.
Method | Description |
---|---|
Starts the migration job. |
|
Stops the migration job. |
Properties
- AdditionalConfiguration
- Data type: StringAccess type: Read/Write Qualifiers:
noneAdditional configuration for migration jobs.For a collection
migration job, the configuration contains the collections
information included in this job. The format is like:
Copy Code <MigrationJob> <Collection ID="JQX00011" Type="2" LimitTo="SMS00019" /> <Collection ID="JQX00012" Type="2" /> <Collection ID="JQX00018" Type="2" /> <SiteCodeMap Old="JQX" New="CAR" /> <SiteCodeMap Old="P5P" New="PE1" /> </Collection> </MigrationJob>
Copy Code <DPUpgrade> <SourceSiteCode>CEN</SourceSiteCode> <SiteCode>CAS</SiteCode> <NALPath>…</NALPath> … <SiteSystem> <NALPath>…</NALPath> … <EmbeddedProperties> <EmbeddedProperty> <PropertyName>IsProtected</PropertyName> <Value>0</Value> <Value1 /> <Value2 /> </EmbeddedProperty> … </EmbeddedProperties> </SiteSystem> <DistributionPoint> … </DistributionPoint> </DPUpgrade>
- CreatedBy
- Data type: StringAccess type: Read-only Qualifiers: [read]Name of the user who created this job.
- CustomBootImagePackage_x64
- Data type: StringAccess type: Read/Write Qualifiers: nonePackageID of a boot image package to use for x64 boot images in place of the default.
- CustomBootImagePackage_x86
- Data type: StringAccess type: Read/Write Qualifiers: nonePackageID of a boot image package to use for x86 boot images in place of the default.
- DateCreated
- Data type: DateTimeAccess type: Read-only Qualifiers: [read]Time that the job was created.
- DateEnded
- Data type: DateTimeAccess type: Read-only Qualifiers: [read]Time that the job ended.
- DateLastUpdated
- Data type: DateTimeAccess type: Read-only Qualifiers: [read]Time that the job was last updated.
- DateNextRun
- Data type: DateTimeAccess type: Read-only Qualifiers: [read]Time that the job will run next.
- DateStarted
- Data type: DateTimeAccess type: Read-only Qualifiers: [read]Time that the job started.
- Description
- Data type: StringAccess type: Read/Write Qualifiers: noneDescription of the job.
- DestinationSiteCode
- Data type: StringAccess type: Read/Write Qualifiers: noneDestination site code.
- DestinationSiteFQDN
- Data type: StringAccess type: Read-only Qualifiers: [read]Destination site FQDN.
- DisableAdvertisements
- Data type: BooleanAccess type: Read/Write Qualifiers: nonetrue if migrated advertisements will be disabled.
- FailedObjectNumber
- Data type: UInt32Access type: Read-only Qualifiers: [read]Number of failed objects.
- JobID
- Data type: UInt32Access type: Read-only Qualifiers: [key, read]Identifier of the job.
- JobName
- Data type: StringAccess type: Read/Write Qualifiers: noneName of the job.
- MigratedObjectNumber
- Data type: UInt32Access type: Read-only Qualifiers: [read]Number of migrated objects.
- MigrateWithFolders
- Data type: BooleanAccess type: Read/Write Qualifiers: nonetrue if the folder structure should be migrated along with the objects.
- ModifiedBy
- Data type: StringAccess type: Read-only Qualifiers: [read]Name of the user who most recently modified this job.
- ResolveObjectConflictOption
- Data type: UInt32Access type: Read/Write Qualifiers: noneResolve object conflict option.
- ScheduleToken
- Data type: StringAccess type: Read/Write Qualifiers: noneSchedule token, writable only with the manage migration Job right..
- ScopeIDs
- Data type: String Array Access type: Read/Write Qualifiers: [lazy]Scope IDs that migrated entities should be in.
- SkippedObjectNumber
- Data type: UInt32Access type: Read-only Qualifiers: [read]Number of skipped objects.
- SourceCollectionIDs
- Data type: String Array Access type: Read/Write Qualifiers: [lazy]Source collection IDs selected for migration.
- SourceObjectIDs
- Data type: UInt32 Array Access type: Read/Write Qualifiers: [lazy]Source object IDs included in the job.
- SourceSiteCode
- Data type: StringAccess type: Read/Write Qualifiers: noneSource site code.
- SourceSiteFQDN
- Data type: StringAccess type: Read-only Qualifiers: [read]Source site FQDN.
- SourceSiteID
- Data type: UInt32Access type: Read/Write Qualifiers: noneSource site ID.
- Status
- Data type: UInt32Access type: Read-only Qualifiers:
[enumeration, read]Job status. Possible values are:
0
NotStarted
1
Completed
2
Running
3
Failed
4
Stopped
- TotalObjectNumber
- Data type: UInt32Access type: Read-only Qualifiers: [read]Number of objects.
- Type
- Data type: UInt32Access type: Read/Write Qualifiers:
[enumeration]The type of job. Possible values are:
1
Object
2
Client
3
ObjectandClient
Remarks
Migration jobs are the object used by the server components to perform a migration task. There are three types of migration jobs: 1) collection migration job, 2) object migration job and 3) distribution point upgrade job. Job types are defined using the Type property.
Collection migration jobs include the collections and collection related information such as the limiting collection, the source site code and the destination site code. Object migration jobs can include objects such as packages, but cannot include the collections and the targeting objects such as advertisements. Distribution point upgrade jobs can upgrade a shared distribution point to a System Center 2012 Configuration Manager regular distribution point.
For collection migration jobs and object migration jobs, the included objects’ entity ID is stored as an array of properties on the job, SourceCollectionIDs and SourceObjectIDs. For distribution point upgrade jobs, the settings for the new site system and distribution point are stored as XML in the property AdditionalConfiguration. All job types are scheduled by using the ScheduleToken property.
Requirements
Runtime Requirements
For more information, see Configuration Manager Server Runtime Requirements.
Development Requirements
For more information, see Configuration Manager Server Development Requirements.