netlab.enums — NETLAB+ VE Python SDK 24.2.0 documentation

# netlab.enums

Netlab enums.

class netlab.enums.AccountType(*values)

  Account type.

  ADMIN = 'Z'

    Admin

  INSTRUCTOR = 'I'

    Instructor

  STUDENT = 'S'

    Student

class netlab.enums.ClassEmailLogs(*values)

  Email reservation logs for real equipment pods.

  INSTRUCTOR = 'P'

    Email to primary instructor.

  NO = 'N'

    Don’t email logs.

class netlab.enums.ClassExtensionSlots(*values)

  The number of times a reservation can be extended.

  COMMUNITY = -1

    Use the community setting.

class netlab.enums.ClassLabLimit(*values)

  Lab limit settings.

  ENFORCE = 'E'

    Enforce class lab limit.

  INSTRUCTOR = 'I'

    Instructor override.

class netlab.enums.CloneStorageAllocation(*values)

  How to allocate VM image.

  ONDEMAND = 'ONDEMAND'

    Allocate on demand.

  PREALLOCATED = 'PREALLOCATED'

    Preallocate.

class netlab.enums.CloneType(*values)

  How to clone.

  FULL = 'FULL'

    Complete copy of the virtual machine.

  LINKED = 'LINKED'

    Delta of a full virtual machine.

class netlab.enums.CommunityExtensionSlots(*values)

  The number of times a reservation can be extended.

  UNLIMITED = -1

    Allow unlimited extensions.

class netlab.enums.ContentAccessiblity(*values)

  Content accessiblity.

  GLOBAL = 'G'

    Globally accessible.

  PRIVATE = 'P'

    Private.

class netlab.enums.FreeAlarm(*values)

  These values are triggered when a disk’s free space has dropped below a determined threshold.

  CLEAR = 'CLEAR'

    The disk has adequate free space.

  CRITICAL = 'CRITICAL'

    The disk is out of free space.

  MAJOR = 'MAJOR'

    The disk is nearly out of free space.

  WARN = 'WARN'

    The disk has reached free space warning

class netlab.enums.HDRStatus(*values)

class netlab.enums.InitConfig(*values)

  Initial configuration.

  EXERCISE = 'E'

    Load default for exercise (if any).

  LAST = 'L'

    Load last saved config (if any).

  NONE = 'N'

    No configs loaded.

class netlab.enums.PCIcon(*values)

  Icon Identifier

  PC = 'P'

    PC

  SERVER = 'S'

    Server

class netlab.enums.PCType(*values)

  PC Type.

  ABSENT = 'ABSENT'

    PC is absent.

  AVMI = 'AVMI'

    PC is in virtual machine inventory.

class netlab.enums.PLIcon(*values)

  Pod design PC icon identifier.

  PC = 'P'

    PC

  SERVER = 'S'

    Server

class netlab.enums.PodAdminState(*values)

  This enumeration describes the administrative states of a pod.

  The administrative state is the state that is desired, not necessarily the current running state (`netlab.enums.PodAdminState`).

  ACTIVE_INIT = 'ACTIVE_INIT'

    Pod is active and initializing.

  ACTIVE_LAB = 'ACTIVE_LAB'

    Pod is active and available for user interaction.

  ACTIVE_LOAD = 'ACTIVE_LOAD'

    Pod is active and loading configuration.

  ACTIVE_POST = 'ACTIVE_POST'

    Pod is active but no longer available for interaction.

  ACTIVE_SAVE = 'ACTIVE_SAVE'

    Pod is active and saving state.

  ACTIVE_TERM = 'ACTIVE_TERM'

    Pod is active and cleaning up.

  CLONING = 'CLONING'

    Pod is in the process of being cloned.

  OFFLINE = 'OFFLINE'

    Pod is offline and idle.

  ONLINE = 'ONLINE'

    Pod is online and idle.

  RESUME = 'RESUME'

    Pod is resuming from a suspended state.

  SUSPENDED = 'SUSPENDED'

    Pod is suspended due to errors.

class netlab.enums.PodCategory(*values)

  Pod category type.

  EPHEMERAL_VM = 'EV'

    Ephemeral VM Pod

  MASTER_VM = 'MV'

    Master VM Pod

  NORMAL_VM = 'NV'

    Normal VM Pod

  PERSISTENT_VM = 'PV'

    Persistent VM Pod

  REAL_EQUIPMENT = 'RE'

    Real Equipment Pod (i.e. Cisco Equipment)

  TEMPLATE_VM = 'TV'

    Template VM Pod

class netlab.enums.PodCurrentState(*values)

  This enumeration describes the possible running states of a pod.

  ACTIVE_INIT = 'ACTIVE_INIT'

    Pod is active and initializing.

  ACTIVE_LAB = 'ACTIVE_LAB'

    Pod is active and available for user interaction.

  ACTIVE_LOAD = 'ACTIVE_LOAD'

    Pod is active and loading configuration.

  ACTIVE_POST = 'ACTIVE_POST'

    Pod is active but no longer available for interaction.

  ACTIVE_SAVE = 'ACTIVE_SAVE'

    Pod is active and saving state.

  ACTIVE_TERM = 'ACTIVE_TERM'

    Pod is active and cleaning up.

  CLONING = 'CLONING'

    Pod is in the process of being cloned.

  OFFLINE = 'OFFLINE'

    Pod is offline and idle.

  ONLINE = 'ONLINE'

    Pod is online and idle.

  RESUME = 'RESUME'

    Pod is resuming from a suspended state.

  SUSPENDED = 'SUSPENDED'

    Pod is suspended due to errors.

class netlab.enums.PodState(*values)

  PC Pod State

  OFFLINE = 'OFFLINE'

    Offline

  ONLINE = 'ONLINE'

    Online.

  RESUME = 'RESUME'

    Resume

class netlab.enums.PowerState(*values)

  Remote PC power state change.

  GUEST_CRASHED = 'GUEST_CRASHED'

    Guest O/S has crashed

  GUEST_REBOOT = 'GUEST_REBOOT'

    Guest O/S reboot started (graceful reboot)

  GUEST_SHUTDOWN = 'GUEST_SHUTDOWN'

    Guest O/S shutdown started (graceful shutdown)

  POWERED_OFF = 'POWER_OFF'

    Remote PC has powered off.

  POWERED_ON = 'POWERED_ON'

    Remote PC has powered on.

  RESET_STARTED = 'RESET_STARTED'

    Remote PC reset started (hard reset)

  RESUME_STARTED = 'RESUME_STARTED'

    Remote PC resume started (from vmware suspended state)

  SUSPENDED = 'SUSPENDED'

    Remote PC has suspended (vmware suspended)

  SUSPEND_STARTED = 'SUSPEND_STARTED'

    Remote PC suspend started (vmware suspend)

  UNKNOWN = 'UNKNOWN'

    PC state can not be determined

class netlab.enums.RemoveVMS(*values)

  How to remove VMs during pod removal.

  DATACENTER = 'DATACENTER'

    Datacenter

  DISK = 'DISK'

    Disk

  LOCAL = 'LOCAL'

    Local

  NONE = 'NONE'

    None

class netlab.enums.ReservationScope(*values)

  Reservation scope.

  ALL = 'ALL'

    All reservations.

  CLASS = 'CLASS'

    Relevant to your class.

  COMMUNITY = 'COMMUNITY'

    Relevant to the community.

  RELEVANT = 'RELEVANT'

    Relevant to caller, i.e. reservations associated with you in context to user role.

class netlab.enums.ReservationType(*values)

  Type of reservation.

  ILT_CLASS = 'C'

    Instructor-led class reservation.

  INDIVIDUAL = 'S'

    Individual student reservation.

  INSTRUCTOR = 'I'

    Instructor reservation for own use.

  TEAM = 'T'

    Team student reservation.

class netlab.enums.VirtualHostComPath(*values)

  Virtual host communication path.

  INSIDE = 'INSIDE'

    Communication will be done on the INSIDE (169.254.0.x) network.

  OUTSIDE = 'OUTSIDE'

    Communication will be done on the OUTSIDE network.

class netlab.enums.VirtualMachineLicenseType(*values)

  Virtual machine type.

  VCENTER = 'vcenter'

    License is for a vm host server.

  VHOST = 'vhost'

    License is for a vCenter server.

class netlab.enums.VirtualMachineRole(*values)

  Virtual machine role in NETLAB+ inventory.

  MASTER = 'MASTER'

    Virtual machine is often associated with the Master Pod. Additional protections are in place to prevent accidental removal.

  NORMAL = 'NORMAL'

    Virtual machine will typically revert to snapshot after reservation.

  PERSISTENT = 'PERSISTENT'

    Virtual machine will not revert to snapshot after reservation.

  TEMPLATE = 'TEMPLATE'

    Pristine virtual machine image used as the basis for cloning many virtual machines. Template VMs cannot be powered on, modified, or assigned to pods.