Reference For: developers

API schemas: L

Schemas of the native REST API whose name starts with L.

LibraryItemView

Library item (GET/POST /v1/content/library-items).

NameTypeRequiredDescription
cachedbooleanyesCached locally.
contentVersionstringyesContent version.
creationTimestringyesCreation time.
datastoreIdstringyesDatastore id.
descriptionstringyesDescription.
filePathstringyesDatastore-relative path of the registered file.
idstringyesItem id (UUID).
lastModifiedTimestringyesLast modification time.
libraryIdstringyesOwning library id.
metadataVersionstringyesMetadata version.
namestringyesDisplay name.
sizeinteger (int64)yesSize in bytes (0 when unknown).
typestringyesiso, ovf, or vm-template.
versionstringyesItem version.

LibraryView

Local content library (GET/POST /v1/content/libraries).

NameTypeRequiredDescription
creationTimestringyesCreation time (RFC3339 / vim wire).
datastoreIdstringyesDatastore backing (datastore-N).
descriptionstringyesDescription.
idstringyesLibrary id (UUID).
lastModifiedTimestringyesLast modification time.
namestringyesDisplay name.
typestringyesAlways LOCAL in this thin slice.
versionstringyesOpaque version.

LicenceStatus

Effective entitlements plus live counters for /v1/licence.

NameTypeRequiredDescription
entitlementsEntitlementsViewyesEffective entitlements.
hostsinteger (int32)yesEnrolled hosts that count toward the limit.
installedarray of InstalledLicenceViewInstalled licence summaries (ids and licensee only).
runningVmsinteger (int32)yesRunning virtual machines that count toward the limit.

LifecycleState

OpenAPI schema of the agent lifecycle state ([kyvernon_vm_model::PowerState]), whose crate has no schema support; lifecycle_schema_matches_the_model keeps the two equal.

Values: "stopped", "starting", "running", "paused", "stopping", "migrating", "incoming", "crashed"

LldpHintView

LLDP neighbour fields (LinkLayerDiscoveryProtocolInfo).

NameTypeRequiredDescription
chassisIdstringyesChassis ID.
mgmtAddrstring or nullOptional management address.
portDescriptionstring or nullOptional port description.
portIdstringyesPort ID.
systemDescriptionstring or nullOptional system description.
systemNamestring or nullOptional system name.
timeToLiveinteger (int32)yesTTL seconds.

LockoutPolicyRequest

Body of PUT /v1/identity/lockout-policy. Applies to the next failed login.

NameTypeRequiredDescription
autoUnlockIntervalSecondsinteger (int64)yes1 to 604800 seconds (seven days); 0 (the lockout lifted by an administrator only) is refused.
descriptionstring or nullText for administrators (kept when absent).
failedAttemptIntervalSecondsinteger (int64)yes1 to 604800 seconds (seven days).
maxFailedAttemptsinteger (int32)yes1 to 1000.

LockoutPolicyView

The account lockout policy.

NameTypeRequiredDescription
autoUnlockIntervalSecondsinteger (int64)yesHow long a locked account stays locked, in seconds (an administrator can lift the lockout earlier).
descriptionstringyesText for administrators.
failedAttemptIntervalSecondsinteger (int64)yesThe window in which failed logins are counted, in seconds.
maxFailedAttemptsinteger (int32)yesFailed logins within failedAttemptIntervalSeconds that lock the account.

LogRecordView

One firewall log record.

NameTypeRequiredDescription
atstringyesTime (RFC 3339).
directionstringyesin or out.
dportinteger (int32) or nullDestination port.
dststringyesDestination.
hoststringyesHost.
monitorbooleanyesThe vNIC was in mode monitor (the packet was forwarded).
nicstringyesNIC id.
protointeger (int32)yesIP protocol.
ruleinteger (int32)yesRule number (0: default or state).
sportinteger (int32) or nullSource port.
srcstringyesSource.
verdictstringyesallow, drop or reject.
vmstringyesVM id.

LogUserEventRequest

Append a user event on an inventory entity (LogUserEvent).

NameTypeRequiredDescription
entityIdstringyesTarget inventory object id.
messagestringyesFree-form message text shown to operators.

LoginRequest

Login request.

NameTypeRequiredDescription
kindstring or nullinteractive (default) or api.
passwordstringyesPassword.
usernamestringyesUsername.

LoginResponse

Login response: either a session or an MFA challenge.

NameTypeRequiredDescription
outcomestringyessession, mfa_required or mfa_enrolment_required.
pendingTokenstring or nullPending token to pass to /identity/mfa/complete (for mfa_required).
sessionSessionView or null

Version 0.1.