Skip to content

Commit 795b564

Browse files
committed
docs: Update various API reference links
Signed-off-by: Doug MacEachern <[email protected]>
1 parent 053de4a commit 795b564

File tree

14 files changed

+24
-25
lines changed

14 files changed

+24
-25
lines changed

cli/vm/create.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -195,7 +195,7 @@ func (cmd *create) Description() string {
195195
return `Create VM.
196196
197197
For a list of possible '-g' IDs, use 'govc vm.option.info' or see:
198-
https://code.vmware.com/apis/358/vsphere/doc/vim.vm.GuestOsDescriptor.GuestOsIdentifier.html
198+
https://developer.broadcom.com/xapis/vsphere-web-services-api/latest/vim.vm.GuestOsDescriptor.GuestOsIdentifier.html
199199
200200
Examples:
201201
govc vm.create -on=false vm-name

examples/datastores/main.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ func main() {
3535
defer v.Destroy(ctx)
3636

3737
// Retrieve summary property for all datastores
38-
// Reference: http://pubs.vmware.com/vsphere-60/topic/com.vmware.wssdk.apiref.doc/vim.Datastore.html
38+
// Reference: https://developer.broadcom.com/xapis/vsphere-web-services-api/latest/vim.Datastore.html
3939
var dss []mo.Datastore
4040
err = v.Retrieve(ctx, []string{"Datastore"}, []string{"summary"}, &dss)
4141
if err != nil {

examples/hosts/main.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ func main() {
3636
defer v.Destroy(ctx)
3737

3838
// Retrieve summary property for all hosts
39-
// Reference: http://pubs.vmware.com/vsphere-60/topic/com.vmware.wssdk.apiref.doc/vim.HostSystem.html
39+
// Reference: https://developer.broadcom.com/xapis/vsphere-web-services-api/latest/vim.HostSystem.html
4040
var hss []mo.HostSystem
4141
err = v.Retrieve(ctx, []string{"HostSystem"}, []string{"summary"}, &hss)
4242
if err != nil {

examples/networks/main.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ func main() {
2626

2727
defer v.Destroy(ctx)
2828

29-
// Reference: http://pubs.vmware.com/vsphere-60/topic/com.vmware.wssdk.apiref.doc/vim.Network.html
29+
// Reference: https://developer.broadcom.com/xapis/vsphere-web-services-api/latest/vim.Network.html
3030
var networks []mo.Network
3131
err = v.Retrieve(ctx, []string{"Network"}, nil, &networks)
3232
if err != nil {

examples/virtualmachines/main.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ func main() {
3232
defer v.Destroy(ctx)
3333

3434
// Retrieve summary property for all machines
35-
// Reference: http://pubs.vmware.com/vsphere-60/topic/com.vmware.wssdk.apiref.doc/vim.VirtualMachine.html
35+
// Reference: https://developer.broadcom.com/xapis/vsphere-web-services-api/latest/vim.VirtualMachine.html
3636
var vms []mo.VirtualMachine
3737
err = v.Retrieve(ctx, []string{"VirtualMachine"}, []string{"summary"}, &vms)
3838
if err != nil {

govc/USAGE.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6846,7 +6846,7 @@ Usage: govc vm.create [OPTIONS] NAME
68466846
Create VM.
68476847
68486848
For a list of possible '-g' IDs, use 'govc vm.option.info' or see:
6849-
https://code.vmware.com/apis/358/vsphere/doc/vim.vm.GuestOsDescriptor.GuestOsIdentifier.html
6849+
https://developer.broadcom.com/xapis/vsphere-web-services-api/latest/vim.vm.GuestOsDescriptor.GuestOsIdentifier.html
68506850
68516851
Examples:
68526852
govc vm.create -on=false vm-name

list/lister.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ func ToElement(r mo.Reference, prefix string) Element {
3030

3131
// Comments about types to be expected in folders copied from the
3232
// documentation of the Folder managed object:
33-
// http://pubs.vmware.com/vsphere-55/topic/com.vmware.wssdk.apiref.doc/vim.Folder.html
33+
// https://developer.broadcom.com/xapis/vsphere-web-services-api/latest/vim.Folder.html
3434
switch m := r.(type) {
3535
case mo.Folder:
3636
name = m.Name

object/distributed_virtual_portgroup.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ func (p DistributedVirtualPortgroup) EthernetCardBackingInfo(ctx context.Context
3838
return nil, err
3939
}
4040

41-
// From the docs at https://code.vmware.com/apis/196/vsphere/doc/vim.dvs.DistributedVirtualPortgroup.ConfigInfo.html:
41+
// From the docs at https://developer.broadcom.com/xapis/vsphere-web-services-api/latest/vim.dvs.DistributedVirtualPortgroup.ConfigInfo.html:
4242
// "This property should always be set unless the user's setting does not have System.Read privilege on the object referred to by this property."
4343
// Note that "the object" refers to the Switch, not the PortGroup.
4444
if dvp.Config.DistributedVirtualSwitch == nil {

property/collector.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ var ErrConcurrentCollector = fmt.Errorf(
2727
// Collector models the PropertyCollector managed object.
2828
//
2929
// For more information, see:
30-
// http://pubs.vmware.com/vsphere-60/index.jsp?topic=%2Fcom.vmware.wssdk.apiref.doc%2Fvmodl.query.PropertyCollector.html
30+
// https://developer.broadcom.com/xapis/vsphere-web-services-api/latest/vmodl.query.PropertyCollector.html
3131
type Collector struct {
3232
mu sync.Mutex
3333
roundTripper soap.RoundTripper

simulator/virtual_machine.go

+4-5
Original file line numberDiff line numberDiff line change
@@ -1147,11 +1147,10 @@ func (vm *VirtualMachine) create(ctx *Context, spec *types.VirtualMachineConfigS
11471147

11481148
var vmwOUI = net.HardwareAddr([]byte{0x0, 0xc, 0x29})
11491149

1150-
// From http://pubs.vmware.com/vsphere-60/index.jsp?topic=%2Fcom.vmware.vsphere.networking.doc%2FGUID-DC7478FF-DC44-4625-9AD7-38208C56A552.html
1151-
// "The host generates generateMAC addresses that consists of the VMware OUI 00:0C:29 and the last three octets in hexadecimal
1152-
//
1153-
// format of the virtual machine UUID. The virtual machine UUID is based on a hash calculated by using the UUID of the
1154-
// ESXi physical machine and the path to the configuration file (.vmx) of the virtual machine."
1150+
// From https://techdocs.broadcom.com/us/en/vmware-cis/vsphere/vsphere/8-0/vsphere-networking-8-0/mac-addresses/mac-address-generation-on-esxi-hosts.html
1151+
// > The host generates generateMAC addresses that consists of the VMware OUI 00:0C:29 and the last three octets in hexadecimal
1152+
// > format of the virtual machine UUID. The virtual machine UUID is based on a hash calculated by using the UUID of the
1153+
// > ESXi physical machine and the path to the configuration file (.vmx) of the virtual machine.
11551154
func (vm *VirtualMachine) generateMAC(unit int32) string {
11561155
id := []byte(vm.Config.Uuid)
11571156

toolbox/README.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,14 @@ overridden and/or extended by consumers.
1212

1313
Feature list from the perspective of vSphere public API interaction. The properties, objects and methods listed are
1414
relative to
15-
the [VirtualMachine](http://pubs.vmware.com/vsphere-60/index.jsp?topic=%2Fcom.vmware.wssdk.apiref.doc%2Fvim.VirtualMachine.html)
15+
the [VirtualMachine](https://developer.broadcom.com/xapis/vsphere-web-services-api/latest/vim.VirtualMachine.html)
1616
managed object type.
1717

1818
### guest.toolsVersionStatus property
1919

2020
The toolbox reports version as `guestToolsUnmanaged`.
2121

22-
See [ToolsVersionStatus](http://pubs.vmware.com/vsphere-60/index.jsp?topic=%2Fcom.vmware.wssdk.apiref.doc%2Fvim.vm.GuestInfo.ToolsVersionStatus.html)
22+
See [ToolsVersionStatus](https://developer.broadcom.com/xapis/vsphere-web-services-api/latest/vim.vm.GuestInfo.ToolsVersionStatus.html)
2323

2424
### guest.toolsRunningStatus and guest.guestState properties
2525

@@ -31,13 +31,13 @@ The VMX requests this value via the `Set_Option broadcastIP` RPC.
3131

3232
The default value can be overridden by setting the `Service.PrimaryIP` function.
3333

34-
See [vim.vm.GuestInfo](http://pubs.vmware.com/vsphere-60/index.jsp?topic=%2Fcom.vmware.wssdk.apiref.doc%2Fvim.vm.GuestInfo.html)
34+
See [vim.vm.GuestInfo](https://developer.broadcom.com/xapis/vsphere-web-services-api/latest/vim.vm.GuestInfo.html)
3535

3636
### guest.net property
3737

3838
This data is pushed to the VMX using the `SendGuestInfo(INFO_IPADDRESS_V3)` RPC.
3939

40-
See [GuestNicInfo](http://pubs.vmware.com/vsphere-60/index.jsp?topic=%2Fcom.vmware.wssdk.apiref.doc%2Fvim.vm.GuestInfo.NicInfo.html).
40+
See [GuestNicInfo](https://developer.broadcom.com/xapis/vsphere-web-services-api/latest/vim.vm.GuestInfo.NicInfo.html).
4141

4242
### ShutdownGuest and RebootGuest methods
4343

@@ -47,7 +47,7 @@ The [PowerCommandHandler](power.go) provides power hooks for customized guest sh
4747

4848
Not supported, but authentication can be customized.
4949

50-
See [vim.vm.guest.AuthManager](http://pubs.vmware.com/vsphere-60/index.jsp?topic=%2Fcom.vmware.wssdk.apiref.doc%2Fvim.vm.guest.AuthManager.html)
50+
See [vim.vm.guest.AuthManager](https://developer.broadcom.com/xapis/vsphere-web-services-api/latest/vim.vm.guest.AuthManager.html)
5151

5252
### GuestFileManager object
5353

@@ -67,7 +67,7 @@ See [vim.vm.guest.AuthManager](http://pubs.vmware.com/vsphere-60/index.jsp?topic
6767
| MoveDirectoryInGuest | Yes | [mv](https://github.com/vmware/govmomi/blob/main/govc/vm/guest/mv.go) |
6868
| MoveFileInGuest | Yes | [mv](https://github.com/vmware/govmomi/blob/main/govc/vm/guest/mv.go) |
6969

70-
See [vim.vm.guest.FileManager](http://pubs.vmware.com/vsphere-60/index.jsp?topic=%2Fcom.vmware.wssdk.apiref.doc%2Fvim.vm.guest.FileManager.html)
70+
See [vim.vm.guest.FileManager](https://developer.broadcom.com/xapis/vsphere-web-services-api/latest/vim.vm.guest.FileManager.html)
7171

7272
### GuestProcessManager
7373

@@ -81,7 +81,7 @@ started by `StartProgramInGuest`.
8181
| StartProgramInGuest | Yes | [start](https://github.com/vmware/govmomi/blob/main/govc/vm/guest/start.go) |
8282
| TerminateProcessInGuest | Yes | [kill](https://github.com/vmware/govmomi/blob/main/govc/vm/guest/kill.go) |
8383

84-
See [vim.vm.guest.ProcessManager](http://pubs.vmware.com/vsphere-60/index.jsp?topic=%2Fcom.vmware.wssdk.apiref.doc%2Fvim.vm.guest.ProcessManager.html)
84+
See [vim.vm.guest.ProcessManager](https://developer.broadcom.com/xapis/vsphere-web-services-api/latest/vim.vm.guest.ProcessManager.html)
8585

8686
## Extensions
8787

toolbox/process/process.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -192,7 +192,7 @@ func (e *Error) Error() string {
192192
}
193193

194194
// Manager manages processes within the guest.
195-
// See: http://pubs.vmware.com/vsphere-60/topic/com.vmware.wssdk.apiref.doc/vim.vm.guest.Manager.html
195+
// See: https://developer.broadcom.com/xapis/vsphere-web-services-api/latest/vim.vm.guest.Manager.html
196196
type Manager struct {
197197
wg sync.WaitGroup
198198
mu sync.Mutex
@@ -271,7 +271,7 @@ func (m *Manager) Start(r *vix.StartProgramRequest, p *Process) (int64, error) {
271271
m.wg.Done()
272272
p.Kill() // cancel context for those waiting on p.ctx.Done()
273273

274-
// See: http://pubs.vmware.com/vsphere-65/topic/com.vmware.wssdk.apiref.doc/vim.vm.guest.ProcessManager.ProcessInfo.html
274+
// See: https://developer.broadcom.com/xapis/vsphere-web-services-api/latest/vim.vm.guest.ProcessManager.ProcessInfo.html
275275
// "If the process was started using StartProgramInGuest then the process completion time
276276
// will be available if queried within 5 minutes after it completes."
277277
<-time.After(m.expire)

vapi/tags/tag_association_test.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -352,7 +352,7 @@ func getRef(t *testing.T, ctx context.Context, client *vim25.Client) (mo.Referen
352352
defer v.Destroy(ctx)
353353

354354
// Retrieve summary property for all machines
355-
// Reference: http://pubs.vmware.com/vsphere-60/topic/com.vmware.wssdk.apiref.doc/vim.VirtualMachine.html
355+
// Reference: https://developer.broadcom.com/xapis/vsphere-web-services-api/latest/vim.VirtualMachine.html
356356
var vms []mo.VirtualMachine
357357
err = v.Retrieve(ctx, []string{"VirtualMachine"}, []string{"summary"}, &vms)
358358
if err != nil {

vcsim/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -395,7 +395,7 @@ To see the list of supported methods:
395395
curl -sk https://user:[email protected]:8989/about
396396
```
397397

398-
[apiref]:https://code.vmware.com/apis/196/vsphere
398+
[apiref]:https://developer.broadcom.com/xapis/vsphere-web-services-api/latest/
399399

400400
## Listen address
401401

0 commit comments

Comments
 (0)