InterfaceMigrationImmediate

Description

Model for interface migration job. (Note: The field level constraints listed here might not cover all the constraints on the field. Additional constraints might exist.)

Supported Operations

Model Properties

Property Required Type Description
version False string A unique string version assigned by the system when the object is created or modified. No assumption can be made on the format or content of this identifier. The identifier must be provided whenever attempting to modify/delete an existing object. As the version will change every time the object is modified, the value provided in this identifier must match exactly what is present in the system or the request will be rejected.
scheduleType False string A mandatory enum value that specifies the type of job schedule. Only allowed value is:

IMMEDIATE - the job will be posted when the request is received.

Note that the job will be posted in the queue when it is received, but the actual execution can be delayed if other jobs were scheduled for execution at the same time or are being currently processed. After a system restart the job will not be recovered.
user False string System provided ID of the user who scheduled the job.
Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
forceOperation False boolean For Internal use.
jobHistoryUuid False string The ID of the job status object created by this schedule object. Use this ID in the corresponding job API to check the job status.
Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
ipAddress False string IP address of actor who initiated a job execution
Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
name False string User provided identifier associated with the scheduled activity.
Field level constraints: length must be between 0 and 128 (inclusive), must match pattern ^[a-zA-Z0-9][a-zA-Z0-9_+-]*$. (Note: Additional constraints might exist)
description False string User provided description of the InterfaceMigrationImmediate.
Field level constraints: length must be between 0 and 200 (inclusive). (Note: Additional constraints might exist)
sourceInterfaceId True string Id of the source interface whose configuration needs to be migrated.
Field level constraints: must match pattern ^((?!;).)*$, cannot be null. (Note: Additional constraints might exist)
sourceInterfaceType True string Type of the source interface. Example - "PhysicalInterface | SubInterface | EtherChannelInterface | VlanInterface | BridgeGroupInterface"
Field level constraints: must match pattern ^((?!;).)*$, cannot be null. (Note: Additional constraints might exist)
destinationInterfaceId True string Id of the destination interface to which the config pointing to the source interface will be migrated to.
Field level constraints: must match pattern ^((?!;).)*$, cannot be null. (Note: Additional constraints might exist)
destinationInterfaceType True string Type of the destination interface. Example - "PhysicalInterface | SubInterface | EtherChannelInterface | VlanInterface | BridgeGroupInterface"
Field level constraints: must match pattern ^((?!;).)*$, cannot be null. (Note: Additional constraints might exist)
jobName False string Read-only field created during task execution.
id False string A unique string identifier assigned by the system when the object is created. No assumption can be made on the format or content of this identifier. The identifier must be provided whenever attempting to modify/delete (or reference) an existing object.
Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
type True string A UTF8 string, all letters lower-case, that represents the class-type. This corresponds to the class name.