_id
stringlengths
2
7
title
stringclasses
1 value
partition
stringclasses
3 values
text
stringlengths
6
2.61k
language
stringclasses
1 value
meta_information
dict
c170100
validation
// IsResourceInUseError checks an error to see if it's of the // ResourceInUse type.
{ "resource": "" }
c170101
validation
// isConcurrentAccessError checks an error to see if it's of the // ConcurrentAccess type.
{ "resource": "" }
c170102
validation
// RenameObject renames a MO and tracks the task to make sure it completes.
{ "resource": "" }
c170103
validation
// VimValidateVirtualCenter ensures that the client is connected to vCenter. // // This is a lower-level method that does not take the wrapped client from the // higher-level govmomi object, and can be used to facilitate validation when // it's not available.
{ "resource": "" }
c170104
validation
// parseVersion creates a new VSphereVersion from a parsed version string and // build number.
{ "resource": "" }
c170105
validation
// parseVersionFromAboutInfo returns a populated VSphereVersion from an // AboutInfo data object. // // This function panics if it cannot parse the version correctly, as given our // source of truth is a valid AboutInfo object, such an error is indicative of // a major issue with our version parsing logic.
{ "resource": "" }
c170106
validation
// ParseVersionFromClient returns a populated VSphereVersion from a client // connection.
{ "resource": "" }
c170107
validation
// String implements stringer for VSphereVersion.
{ "resource": "" }
c170108
validation
// ProductEqual returns true if this version's product name is the same as the // supplied version's name.
{ "resource": "" }
c170109
validation
// Older returns true if this version's product is the same, and composite of // the version and build numbers, are older than the supplied version's // information.
{ "resource": "" }
c170110
validation
// Equal returns true if the version is equal to the supplied version.
{ "resource": "" }
c170111
validation
// expandClusterVMGroup reads certain ResourceData keys and returns a // ClusterVmGroup.
{ "resource": "" }
c170112
validation
// flattenClusterVmGroup saves a ClusterVmGroup into the supplied ResourceData.
{ "resource": "" }
c170113
validation
// resourceVSphereComputeClusterVMGroupFindEntry attempts to locate an existing // VM group config in a cluster's configuration. It's used by the resource's // read functionality and tests. nil is returned if the entry cannot be found.
{ "resource": "" }
c170114
validation
// resourceVSphereComputeClusterVMGroupFetchObjects fetches the "objects" for a // cluster VM group. This is currently just the cluster object as the name of // the group is a static value and a pass-through - this is to keep its // workflow consistent with other cluster-dependent resources that derive from // ArrayUpd...
{ "resource": "" }
c170115
validation
// resourceVSphereResourcePoolApplyTags processes the tags step for both create // and update for vsphere_resource_pool.
{ "resource": "" }
c170116
validation
// resourceVSphereResourcePoolReadTags reads the tags for // vsphere_resource_pool.
{ "resource": "" }
c170117
validation
// expandClusterAffinityRuleSpec reads certain ResourceData keys and returns a // ClusterAffinityRuleSpec.
{ "resource": "" }
c170118
validation
// flattenClusterAffinityRuleSpec saves a ClusterAffinityRuleSpec into the supplied ResourceData.
{ "resource": "" }
c170119
validation
// resourceVSphereComputeClusterVMAffinityRuleFindEntry attempts to locate an // existing VM affinity rule in a cluster's configuration by key. It's used by the // resource's read functionality and tests. nil is returned if the entry cannot // be found.
{ "resource": "" }
c170120
validation
// ConfigSchema returns the schema for custom attribute configuration // for each resource that needs it. // // The key should be set to the ConfigKey constant and should be a // map of custom attribute ids to values.
{ "resource": "" }
c170121
validation
// VirtualMachineCloneSchema represents the schema for the VM clone sub-resource. // // This is a workflow for vsphere_virtual_machine that facilitates the creation // of a virtual machine through cloning from an existing template. // Customization is nested here, even though it exists in its own workflow.
{ "resource": "" }
c170122
validation
// ValidateVirtualMachineClone does pre-creation validation of a virtual // machine's configuration to make sure it's suitable for use in cloning. // This includes, but is not limited to checking to make sure that the disks in // the new VM configuration line up with the configuration in the existing // template, and c...
{ "resource": "" }
c170123
validation
// validateCloneSnapshots checks a VM to make sure it has a single snapshot // with no children, to make sure there is no ambiguity when selecting a // snapshot for linked clones.
{ "resource": "" }
c170124
validation
// ReferenceProperties is a convenience method that wraps fetching the Network // MO from a NetworkReference. // // Note that regardless of the network type, this only fetches the Network MO // and not any of the extended properties of that network.
{ "resource": "" }
c170125
validation
// SystemOrDefault returns a HostSystem from a specific host name and // datacenter. If the user is connecting over ESXi, the default host system is // used.
{ "resource": "" }
c170126
validation
// Properties is a convenience method that wraps fetching the HostSystem MO // from its higher-level object.
{ "resource": "" }
c170127
validation
// ResourcePool is a convenience method that wraps fetching the host system's // root resource pool
{ "resource": "" }
c170128
validation
// hostSystemNameFromID returns the name of a host via its its managed object // reference ID.
{ "resource": "" }
c170129
validation
// NameOrID is a convenience method mainly for helping displaying friendly // errors where space is important - it displays either the host name or the ID // if there was an error fetching it.
{ "resource": "" }
c170130
validation
// EnterMaintenanceMode puts a host into maintenance mode. If evacuate is set // to true, all powered off VMs will be removed from the host, or the task will // block until this is the case, depending on whether or not DRS is on or off // for the host's cluster. This parameter is ignored on direct ESXi.
{ "resource": "" }
c170131
validation
// ExitMaintenanceMode takes a host out of maintenance mode.
{ "resource": "" }
c170132
validation
// dvsFromUUID gets a DVS object from its UUID.
{ "resource": "" }
c170133
validation
// dvsFromPath gets a DVS object from its path.
{ "resource": "" }
c170134
validation
// dvsProperties is a convenience method that wraps fetching the DVS MO from // its higher-level object.
{ "resource": "" }
c170135
validation
// upgradeDVS upgrades a DVS to a specific version. Downgrades are not // supported and will result in an error. This should be checked before running // this function.
{ "resource": "" }
c170136
validation
// enableDVSNetworkResourceManagement exposes the // EnableNetworkResourceManagement method of the DistributedVirtualSwitch MO. // This local implementation may go away if this is exposed in the higher-level // object upstream.
{ "resource": "" }
c170137
validation
// resourceVSphereDatastoreClusterVMAntiAffinityRuleFlattenID makes an ID for the // vsphere_datastore_cluster_vm_anti_affinity_rule resource.
{ "resource": "" }
c170138
validation
// resourceVSphereDatastoreClusterVMAntiAffinityRuleFindEntry attempts to // locate an existing VM anti-affinity rule in a datastore cluster's // configuration by key. It's used by the resource's read functionality and // tests. nil is returned if the entry cannot be found.
{ "resource": "" }
c170139
validation
// resourceVSphereDatastoreClusterVMAntiAffinityRuleFindEntryByName attempts to // locate an existing VM anti-affinity rule in a datastore cluster's // configuration by name. It differs from the standard // resourceVSphereDatastoreClusterVMAntiAffinityRuleFindEntry in that we don't // allow missing entries, as it's des...
{ "resource": "" }
c170140
validation
// resourceVSphereDatastoreClusterVMAntiAffinityRuleFetchObjects fetches the // "objects" for a cluster rule. This is currently just the cluster object as // the rule key a static value and a pass-through - this is to keep its // workflow consistent with other cluster-dependent resources that derive from // ArrayUpdate...
{ "resource": "" }
c170141
validation
// controllerTypeToClass converts a controller type to a specific short-form // controller class, namely for use with working with IDs.
{ "resource": "" }
c170142
validation
// Addr returns the resource address for this subresource.
{ "resource": "" }
c170143
validation
// HasChange checks to see if there has been a change in the resource data // since the last update. // // Note that this operation may only be useful during update operations, // depending on subresource-specific workflow.
{ "resource": "" }
c170144
validation
// GetChange gets the old and new values for the value specified by key.
{ "resource": "" }
c170145
validation
// GetWithRestart checks to see if a field has been modified, returns the new // value, and sets restart if it has changed.
{ "resource": "" }
c170146
validation
// GetWithVeto returns the value specified by key, but returns an error if it // has changed. The intention here is to block changes to the resource in a // fashion that would otherwise result in forcing a new resource.
{ "resource": "" }
c170147
validation
// SetRestart sets reboot_required in the global ResourceData. The key is only // required for logging.
{ "resource": "" }
c170148
validation
// Hash calculates a set hash for the current data. If you want a hash for // error reporting a device address, it's probably a good idea to run this at // the beginning of a run as any set calls will change the value this // ultimately calculates.
{ "resource": "" }
c170149
validation
// computeDevAddr handles the logic for SaveDevIDs and allows it to be used // outside of a subresource.
{ "resource": "" }
c170150
validation
// splitDevAddr splits an device addres into its inparticular parts and asserts // that we have all the correct data.
{ "resource": "" }
c170151
validation
// findVirtualDeviceInListControllerSelectFunc returns a function that can be // used with VirtualDeviceList.Select to locate a controller device based on // the criteria that we have laid out.
{ "resource": "" }
c170152
validation
// findVirtualDeviceInListDeviceSelectFunc returns a function that can be used // with VirtualDeviceList.Select to locate a virtual device based on its // controller device key, and the unit number on the device.
{ "resource": "" }
c170153
validation
// findControllerForDevice locates a controller via its virtual device.
{ "resource": "" }
c170154
validation
// FindVirtualDeviceByAddr locates the subresource's virtual device in the // supplied VirtualDeviceList by its device address.
{ "resource": "" }
c170155
validation
// FindVirtualDevice will attempt to find an address by its device key if it is // > 0, otherwise it will attempt to locate it by its device address.
{ "resource": "" }
c170156
validation
// String prints out the device sub-resource's information including the ID at // time of instantiation, the short name of the disk, and the current device // key and address.
{ "resource": "" }
c170157
validation
// swapSCSIDevice swaps out the supplied controller for a new one of the // supplied controller type. Any connected devices are re-connected at the same // device units on the new device. A list of changes is returned.
{ "resource": "" }
c170158
validation
// NormalizeSCSIBus checks the SCSI controllers on the virtual machine and // either creates them if they don't exist, or migrates them to the specified // controller type. Devices are migrated to the new controller appropriately. A // spec slice is returned with the changes. // // The first number of slots specified b...
{ "resource": "" }
c170159
validation
// setSCSIBusSharing takes a BaseVirtualSCSIController, sets the sharing mode, // and applies that change to the VirtualDeviceList.
{ "resource": "" }
c170160
validation
// createSCSIController creates a new SCSI controller of the specified type and // sharing mode.
{ "resource": "" }
c170161
validation
// ReadSCSIBusType checks the SCSI bus state and returns a device type // depending on if all controllers are one specific kind or not. Only the first // number of controllers specified by count are checked.
{ "resource": "" }
c170162
validation
// ReadSCSIBusSharing checks the SCSI bus sharing and returns a sharing type // depending on if all controllers are one specific kind or not. Only the first // number of controllers specified by count are checked.
{ "resource": "" }
c170163
validation
// getSCSIController picks a SCSI controller at the specific bus number supplied.
{ "resource": "" }
c170164
validation
// ControllerForCreateUpdate wraps the controller selection logic to make it // easier to use in create or update operations. If the controller type is a // SCSI device, the bus number is searched as well.
{ "resource": "" }
c170165
validation
// applyDeviceChange applies a pending types.BaseVirtualDeviceConfigSpec to a // working set to either add, remove, or update devices so that the working // VirtualDeviceList is as up to date as possible.
{ "resource": "" }
c170166
validation
// DeviceListString pretty-prints each device in a virtual device list, used // for logging purposes and what not.
{ "resource": "" }
c170167
validation
// DeviceChangeString pretty-prints a slice of VirtualDeviceConfigSpec.
{ "resource": "" }
c170168
validation
// subresourceListString takes a list of sub-resources and pretty-prints the // key and device address.
{ "resource": "" }
c170169
validation
// scsiControllerListString pretty-prints a slice of SCSI controllers.
{ "resource": "" }
c170170
validation
// AppendDeviceChangeSpec appends unique copies of the supplied device change // operations and appends them to spec. The resulting list is returned. // // The object of this function is to provide deep copies of each virtual device // to the spec as they looked like when the append operation was called, // helping fac...
{ "resource": "" }
c170171
validation
// expandClusterDependencyRuleInfo reads certain ResourceData keys and returns a // ClusterDependencyRuleInfo.
{ "resource": "" }
c170172
validation
// flattenClusterDependencyRuleInfo saves a ClusterDependencyRuleInfo into the supplied ResourceData.
{ "resource": "" }
c170173
validation
// resourceVSphereComputeClusterVMDependencyRuleParseID parses an ID for the // vsphere_compute_cluster_vm_dependency_rule and outputs its parts.
{ "resource": "" }
c170174
validation
// resourceVSphereComputeClusterVMDependencyRuleFetchObjects fetches the "objects" // for a cluster rule. This is currently just the cluster object as the rule // key a static value and a pass-through - this is to keep its workflow // consistent with other cluster-dependent resources that derive from // ArrayUpdateSpec...
{ "resource": "" }
c170175
validation
// resourceVSphereDatastoreClusterApplyCreate processes the creation part of // resourceVSphereDatastoreClusterCreate.
{ "resource": "" }
c170176
validation
// resourceVSphereDatastoreClusterApplyTags processes the tags step for both // create and update for vsphere_datastore_cluster.
{ "resource": "" }
c170177
validation
// resourceVSphereDatastoreClusterReadTags reads the tags for // vsphere_datastore_cluster.
{ "resource": "" }
c170178
validation
// resourceVSphereDatastoreClusterApplyCustomAttributes processes the custom // attributes step for both create and update for vsphere_datastore_cluster.
{ "resource": "" }
c170179
validation
// resourceVSphereDatastoreClusterReadCustomAttributes reads the custom // attributes for vsphere_datastore_cluster.
{ "resource": "" }
c170180
validation
// resourceVSphereDatastoreClusterApplySDRSConfig applies the SDRS // configuration to a datastore cluster.
{ "resource": "" }
c170181
validation
// resourceVSphereDatastoreClusterHasSDRSConfigChange checks all resource keys // associated with storage DRS to see if there has been a change in the // configuration of those keys. This helper is designed to detect no-ops in a // SDRS configuration to see if we really need to send a configure API call to // vSphere.
{ "resource": "" }
c170182
validation
// resourceVSphereDatastoreClusterGetPod gets the StoragePod from the ID // in the supplied ResourceData.
{ "resource": "" }
c170183
validation
// resourceVSphereDatastoreClusterGetPodFromPath gets the StoragePod from a // supplied path. If no datacenter is supplied, the path must be a full path.
{ "resource": "" }
c170184
validation
// resourceVSphereDatastoreClusterSaveNameAndPath saves the name and path of a // StoragePod into the supplied ResourceData.
{ "resource": "" }
c170185
validation
// resourceVSphereDatastoreClusterApplyNameChange applies any changes to a // StoragePod's name.
{ "resource": "" }
c170186
validation
// resourceVSphereDatastoreClusterApplyFolderChange applies any changes to a // StoragePod's folder location.
{ "resource": "" }
c170187
validation
// resourceVSphereDatastoreClusterValidateEmptyCluster validates that the // datastore cluster is empty. This is used to ensure a safe deletion of the // cluster - we do not allow deletion of clusters that still have datastores in // them.
{ "resource": "" }
c170188
validation
// resourceVSphereDatastoreClusterApplyDelete process the removal of a // datastore cluster.
{ "resource": "" }
c170189
validation
// resourceVSphereDatastoreClusterFlattenSDRSData saves the DRS attributes from // a StoragePod into the supplied ResourceData. // // Note that other functions handle non-SDRS related items, such as path, name, // tags, and custom attributes.
{ "resource": "" }
c170190
validation
// expandStorageDrsPodConfigSpec reads certain ResourceData keys and returns a // StorageDrsPodConfigSpec.
{ "resource": "" }
c170191
validation
// flattenStorageDrsPodConfigInfo saves a StorageDrsPodConfigInfo into the // supplied ResourceData.
{ "resource": "" }
c170192
validation
// expandStorageDrsAutomationConfig reads certain ResourceData keys and returns // a StorageDrsAutomationConfig.
{ "resource": "" }
c170193
validation
// flattenStorageDrsAutomationConfig saves a StorageDrsAutomationConfig into // the supplied ResourceData.
{ "resource": "" }
c170194
validation
// expandStorageDrsIoLoadBalanceConfig reads certain ResourceData keys and returns // a StorageDrsIoLoadBalanceConfig.
{ "resource": "" }
c170195
validation
// flattenStorageDrsIoLoadBalanceConfig saves a StorageDrsIoLoadBalanceConfig // into the supplied ResourceData.
{ "resource": "" }
c170196
validation
// expandStorageDrsSpaceLoadBalanceConfig reads certain ResourceData keys and returns // a StorageDrsSpaceLoadBalanceConfig.
{ "resource": "" }
c170197
validation
// flattenStorageDrsSpaceLoadBalanceConfig saves a // StorageDrsSpaceLoadBalanceConfig into the supplied ResourceData.
{ "resource": "" }
c170198
validation
// expandStorageDrsOptionSpec reads certain ResourceData keys and returns // a StorageDrsOptionSpec.
{ "resource": "" }
c170199
validation
// flattenStorageDrsOptionSpec saves a StorageDrsOptionSpec into the supplied // ResourceData.
{ "resource": "" }