Overzicht van de compatibiliteit

Kyvernon biedt naast zijn native API de vSphere SOAP-API (vim25), de REST-automatiserings-API, toegang tot datastorebestanden en het OVF-overdrachtsendpoint aan. De controller biedt ze aan op dezelfde listener en hetzelfde certificaat als de native API, dus een tool maakt verbinding met het adres van de controller (poort 8443 in de voorbeelden). De endpoints staan uit tot [facades] enabled = true is ingesteld in controller.toml; zie Instellingen van de compatibiliteitsendpoints.

Endpoints

Sessies en accounts

Een client meldt zich aan met de gebruikersnaam en het wachtwoord van een Kyvernon-account. De machtigingen van het account bepalen wat de client ziet en mag doen: bevoegdheden gebruiken de vSphere-identificaties en gelden voor dezelfde objecten als in de console. Een object dat het account niet mag lezen, wordt niet gemeld en de PropertyCollector loopt er niet doorheen. Schrijfbewerkingen controleren de bevoegdheid van de bewerking op het doel en antwoorden met een NoPermission-fout als die ontbreekt.

De aanmelding bij de facade volgt het aanmeldbeleid van de controller: blokkering en auditrecords zijn van toepassing. Er is geen interactieve vraag om tweestapsverificatie bij de vim25-aanmelding. Een account dat zijn wachtwoord moet wijzigen, wordt geweigerd tot het dat heeft gedaan. Een sessie eindigt na 30 minuten zonder verzoeken (session_timeout) en wanneer het account of zijn sessies via een willekeurige API worden ingetrokken.

Objectverwijzingen en taken

Verwijzingen naar beheerde objecten gebruiken de id's van de native API in de vSphere-vormen, zoals vm-42, host-7, datastore-3, network-5, domain-c1 en resgroup-1. Bewerkingen waarvan de naam op _Task eindigt, geven een taakverwijzing terug waarop tools wachten met de PropertyCollector. Het zijn dezelfde taken als in de console en de native API. Eigenschapspaden zoals config.hardware.device worden herleid op de beheerde objecten die de endpoints aanbieden.

Methoden die niet worden aangeboden

De vim25-API heeft 972 methoden. Kyvernon biedt er 196 van aan: de methoden die de geverifieerde tools gebruiken, per beheerd object gegroepeerd in de naslag ondersteunde methoden van de vSphere-API. Een methode die deel is van de API en niet wordt aangeboden, geeft een NotSupported-fout terug, zodat een tool die haar aanroept zichtbaar mislukt. Een naam buiten de API geeft MethodNotFound. Voorbeelden van methoden die niet worden aangeboden zijn ShutdownGuest, RebootGuest, de methoden van LicenseManager en CreateDVS_Task. Gebruik voor deze functies de native API, bijvoorbeeld kyvernon vm shutdown <id>.

Productidentificatie

De service-informatie (about) noemt Kyvernon als product. Sommige tools controleren de productnaam voordat ze een functie inschakelen; de instelling product_name in [facades] wijzigt de naam die de endpoints melden. Zie Instellingen van de compatibiliteitsendpoints voor welke tool dit nodig heeft.

Cloud-images

Linux-cloud-images met cloud-init worden gepersonaliseerd met de extraConfig-sleutels die de VMware-datasource van cloud-init leest: guestinfo.userdata, guestinfo.metadata en guestinfo.vendordata, elk met een optionele .encoding van base64 of gzip+base64. Kyvernon geeft de gegevens aan de gast door als een alleen-lezen NoCloud-schijf. De sleutels die het Terraform-argument extra_config, govc vm.change -e of de geavanceerde instellingen van PowerCLI instellen, werken zonder wijzigingen. Ongeldige gegevens laten de taak die ze instelt mislukken, met de sleutel genoemd.

Verwante taken

• PowerCLI, govc, Terraform, Ansible
• Instellingen van de compatibiliteitsendpoints
• Terminologie voor vSphere-gebruikers