github.com/vmware/govmomi@v0.51.0/simulator/esx/command_info.go (about)

     1  // © Broadcom. All Rights Reserved.
     2  // The term “Broadcom” refers to Broadcom Inc. and/or its subsidiaries.
     3  // SPDX-License-Identifier: Apache-2.0
     4  
     5  package esx
     6  
     7  import (
     8  	"github.com/vmware/govmomi/cli/esx"
     9  )
    10  
    11  // CommandInfo generated via `govc host.esxcli.model -c -dump`
    12  var CommandInfo = []esx.CommandInfo{
    13  	{
    14  		CommandInfoItem: esx.CommandInfoItem{Name: "hardware.clock", DisplayName: "clock", Help: "Interaction with the hardware clock."},
    15  		Method: []esx.CommandInfoMethod{
    16  			{
    17  				CommandInfoItem: esx.CommandInfoItem{Name: "get", DisplayName: "get", Help: "Display the current hardware clock time."},
    18  				Param:           nil,
    19  				Hints: esx.CommandInfoHints{
    20  					{Key: "formatter", Value: "simple"},
    21  				},
    22  			},
    23  			{
    24  				CommandInfoItem: esx.CommandInfoItem{Name: "set", DisplayName: "set", Help: "Set the hardware clock time. Any missing parameters will default to the current time."},
    25  				Param: []esx.CommandInfoParam{
    26  					{
    27  						CommandInfoItem: esx.CommandInfoItem{Name: "day", DisplayName: "day", Help: "Day"},
    28  						Aliases:         []string{"-d", "--day"},
    29  						Flag:            false,
    30  					},
    31  					{
    32  						CommandInfoItem: esx.CommandInfoItem{Name: "hour", DisplayName: "hour", Help: "Hour"},
    33  						Aliases:         []string{"-H", "--hour"},
    34  						Flag:            false,
    35  					},
    36  					{
    37  						CommandInfoItem: esx.CommandInfoItem{Name: "min", DisplayName: "min", Help: "Minute"},
    38  						Aliases:         []string{"-m", "--min"},
    39  						Flag:            false,
    40  					},
    41  					{
    42  						CommandInfoItem: esx.CommandInfoItem{Name: "month", DisplayName: "month", Help: "Month"},
    43  						Aliases:         []string{"-M", "--month"},
    44  						Flag:            false,
    45  					},
    46  					{
    47  						CommandInfoItem: esx.CommandInfoItem{Name: "sec", DisplayName: "sec", Help: "Second"},
    48  						Aliases:         []string{"-s", "--sec"},
    49  						Flag:            false,
    50  					},
    51  					{
    52  						CommandInfoItem: esx.CommandInfoItem{Name: "year", DisplayName: "year", Help: "Year"},
    53  						Aliases:         []string{"-y", "--year"},
    54  						Flag:            false,
    55  					},
    56  				},
    57  				Hints: esx.CommandInfoHints{
    58  					{Key: "formatter", Value: ""},
    59  				},
    60  			},
    61  		},
    62  	},
    63  	{
    64  		CommandInfoItem: esx.CommandInfoItem{Name: "hardware.platform", DisplayName: "platform", Help: "Platform information."},
    65  		Method: []esx.CommandInfoMethod{
    66  			{
    67  				CommandInfoItem: esx.CommandInfoItem{Name: "get", DisplayName: "get", Help: "Get information about the platform"},
    68  				Param:           nil,
    69  				Hints: esx.CommandInfoHints{
    70  					{Key: "fields:PlatformGet", Value: "UUID,Product Name,Vendor Name,Serial Number,Enclosure Serial Number,BIOS Asset Tag,IPMI Supported"},
    71  					{Key: "formatter", Value: "simple"},
    72  					{Key: "header:PlatformGet", Value: "Platform Information"},
    73  				},
    74  			},
    75  		},
    76  	},
    77  	{
    78  		CommandInfoItem: esx.CommandInfoItem{Name: "iscsi.software", DisplayName: "software", Help: "Operations that can be performed on software iSCSI"},
    79  		Method: []esx.CommandInfoMethod{
    80  			{
    81  				CommandInfoItem: esx.CommandInfoItem{Name: "get", DisplayName: "get", Help: "Software iSCSI information."},
    82  				Param:           nil,
    83  				Hints: esx.CommandInfoHints{
    84  					{Key: "formatter", Value: "simple"},
    85  				},
    86  			},
    87  			{
    88  				CommandInfoItem: esx.CommandInfoItem{Name: "set", DisplayName: "set", Help: "Enable or disable software iSCSI."},
    89  				Param: []esx.CommandInfoParam{
    90  					{
    91  						CommandInfoItem: esx.CommandInfoItem{Name: "enabled", DisplayName: "enabled", Help: "Enable or disable the module."},
    92  						Aliases:         []string{"-e", "--enabled"},
    93  						Flag:            false,
    94  					},
    95  					{
    96  						CommandInfoItem: esx.CommandInfoItem{Name: "name", DisplayName: "name", Help: "The iSCSI initiator name.\nThe initiator name must not be specified when disabling software iSCSI."},
    97  						Aliases:         []string{"-n", "--name"},
    98  						Flag:            false,
    99  					},
   100  				},
   101  				Hints: esx.CommandInfoHints{
   102  					{Key: "formatter", Value: "simple"},
   103  				},
   104  			},
   105  		},
   106  	},
   107  	{
   108  		CommandInfoItem: esx.CommandInfoItem{Name: "network.firewall", DisplayName: "firewall", Help: "A set of commands for firewall related operations"},
   109  		Method: []esx.CommandInfoMethod{
   110  			{
   111  				CommandInfoItem: esx.CommandInfoItem{Name: "get", DisplayName: "get", Help: "Get the firewall status."},
   112  				Param:           nil,
   113  				Hints: esx.CommandInfoHints{
   114  					{Key: "formatter", Value: "simple"},
   115  				},
   116  			},
   117  			{
   118  				CommandInfoItem: esx.CommandInfoItem{Name: "load", DisplayName: "load", Help: "Load firewall module and rulesets configuration."},
   119  				Param:           nil,
   120  				Hints: esx.CommandInfoHints{
   121  					{Key: "formatter", Value: ""},
   122  				},
   123  			},
   124  			{
   125  				CommandInfoItem: esx.CommandInfoItem{Name: "refresh", DisplayName: "refresh", Help: "Load ruleset configuration for firewall."},
   126  				Param:           nil,
   127  				Hints: esx.CommandInfoHints{
   128  					{Key: "formatter", Value: ""},
   129  				},
   130  			},
   131  			{
   132  				CommandInfoItem: esx.CommandInfoItem{Name: "set", DisplayName: "set", Help: "Set firewall enabled status and default action."},
   133  				Param: []esx.CommandInfoParam{
   134  					{
   135  						CommandInfoItem: esx.CommandInfoItem{Name: "defaultaction", DisplayName: "default-action", Help: "Set to true to set defaultaction PASS, set to false to DROP."},
   136  						Aliases:         []string{"-d", "--default-action"},
   137  						Flag:            false,
   138  					},
   139  					{
   140  						CommandInfoItem: esx.CommandInfoItem{Name: "enabled", DisplayName: "enabled", Help: "Set to true to enable the firewall, set to false to disable the firewall."},
   141  						Aliases:         []string{"-e", "--enabled"},
   142  						Flag:            false,
   143  					},
   144  				},
   145  				Hints: esx.CommandInfoHints{
   146  					{Key: "formatter", Value: ""},
   147  				},
   148  			},
   149  			{
   150  				CommandInfoItem: esx.CommandInfoItem{Name: "unload", DisplayName: "unload", Help: "Allow unload firewall module."},
   151  				Param:           nil,
   152  				Hints: esx.CommandInfoHints{
   153  					{Key: "formatter", Value: ""},
   154  				},
   155  			},
   156  		},
   157  	},
   158  	{
   159  		CommandInfoItem: esx.CommandInfoItem{Name: "network.ip.connection", DisplayName: "connection", Help: "List active tcpip connections"},
   160  		Method: []esx.CommandInfoMethod{
   161  			{
   162  				CommandInfoItem: esx.CommandInfoItem{Name: "list", DisplayName: "list", Help: "List active TCP/IP connections"},
   163  				Param: []esx.CommandInfoParam{
   164  					{
   165  						CommandInfoItem: esx.CommandInfoItem{Name: "netstack", DisplayName: "netstack", Help: "The network stack instance; if unspecified, use the default netstack instance"},
   166  						Aliases:         []string{"-N", "--netstack"},
   167  						Flag:            false,
   168  					},
   169  					{
   170  						CommandInfoItem: esx.CommandInfoItem{Name: "type", DisplayName: "type", Help: "Connection type: [ip, tcp, udp, all]"},
   171  						Aliases:         []string{"-t", "--type"},
   172  						Flag:            false,
   173  					},
   174  				},
   175  				Hints: esx.CommandInfoHints{
   176  					{Key: "fields:IpConnection", Value: "Proto,Recv Q,Send Q,Local Address,Foreign Address,State,World ID,CC Algo,World Name"},
   177  					{Key: "formatter", Value: "table"},
   178  				},
   179  			},
   180  		},
   181  	},
   182  	{
   183  		CommandInfoItem: esx.CommandInfoItem{Name: "network.nic.ring.current", DisplayName: "current", Help: "Commands to access current NIC RX/TX ring buffer parameters"},
   184  		Method: []esx.CommandInfoMethod{
   185  			{
   186  				CommandInfoItem: esx.CommandInfoItem{Name: "get", DisplayName: "get", Help: "Get current RX/TX ring buffer parameters of a NIC"},
   187  				Param: []esx.CommandInfoParam{
   188  					{
   189  						CommandInfoItem: esx.CommandInfoItem{Name: "nicname", DisplayName: "nic-name", Help: "The name of the NIC whose current RX/TX ring buffer parameters should be retrieved."},
   190  						Aliases:         []string{"-n", "--nic-name"},
   191  						Flag:            false,
   192  					},
   193  				},
   194  				Hints: esx.CommandInfoHints{
   195  					{Key: "fields:RingInfo", Value: "RX,RX Mini,RX Jumbo,TX"},
   196  					{Key: "formatter", Value: "simple"},
   197  				},
   198  			},
   199  			{
   200  				CommandInfoItem: esx.CommandInfoItem{Name: "set", DisplayName: "set", Help: "Set current RX/TX ring buffer parameters of a NIC"},
   201  				Param: []esx.CommandInfoParam{
   202  					{
   203  						CommandInfoItem: esx.CommandInfoItem{Name: "nicname", DisplayName: "nic-name", Help: "The name of the NIC whose current RX/TX ring buffer parameters should be set."},
   204  						Aliases:         []string{"-n", "--nic-name"},
   205  						Flag:            false,
   206  					},
   207  					{
   208  						CommandInfoItem: esx.CommandInfoItem{Name: "rx", DisplayName: "rx", Help: "Number of ring entries for the RX ring."},
   209  						Aliases:         []string{"-r", "--rx"},
   210  						Flag:            false,
   211  					},
   212  					{
   213  						CommandInfoItem: esx.CommandInfoItem{Name: "rxjumbo", DisplayName: "rx-jumbo", Help: "Number of ring entries for the RX jumbo ring."},
   214  						Aliases:         []string{"-j", "--rx-jumbo"},
   215  						Flag:            false,
   216  					},
   217  					{
   218  						CommandInfoItem: esx.CommandInfoItem{Name: "rxmini", DisplayName: "rx-mini", Help: "Number of ring entries for the RX mini ring."},
   219  						Aliases:         []string{"-m", "--rx-mini"},
   220  						Flag:            false,
   221  					},
   222  					{
   223  						CommandInfoItem: esx.CommandInfoItem{Name: "tx", DisplayName: "tx", Help: "Number of ring entries for the TX ring."},
   224  						Aliases:         []string{"-t", "--tx"},
   225  						Flag:            false,
   226  					},
   227  				},
   228  				Hints: esx.CommandInfoHints{
   229  					{Key: "formatter", Value: ""},
   230  				},
   231  			},
   232  		},
   233  	},
   234  	{
   235  		CommandInfoItem: esx.CommandInfoItem{Name: "network.nic.ring.preset", DisplayName: "preset", Help: "Commands to access preset maximums for NIC RX/TX ring buffer parameters."},
   236  		Method: []esx.CommandInfoMethod{
   237  			{
   238  				CommandInfoItem: esx.CommandInfoItem{Name: "get", DisplayName: "get", Help: "Get preset maximums for RX/TX ring buffer parameters of a NIC."},
   239  				Param: []esx.CommandInfoParam{
   240  					{
   241  						CommandInfoItem: esx.CommandInfoItem{Name: "nicname", DisplayName: "nic-name", Help: "The name of the NIC whose preset maximums for RX/TX ring buffer parameters should be retrieved."},
   242  						Aliases:         []string{"-n", "--nic-name"},
   243  						Flag:            false,
   244  					},
   245  				},
   246  				Hints: esx.CommandInfoHints{
   247  					{Key: "fields:RingInfo", Value: "Max RX,Max RX Mini,Max RX Jumbo,Max TX"},
   248  					{Key: "formatter", Value: "simple"},
   249  				},
   250  			},
   251  		},
   252  	},
   253  	{
   254  		CommandInfoItem: esx.CommandInfoItem{Name: "network.vm", DisplayName: "vm", Help: "A set of commands for VM related operations"},
   255  		Method: []esx.CommandInfoMethod{
   256  			{
   257  				CommandInfoItem: esx.CommandInfoItem{Name: "list", DisplayName: "list", Help: "List networking information for the VM's that have active ports."},
   258  				Param:           nil,
   259  				Hints: esx.CommandInfoHints{
   260  					{Key: "fields:VM", Value: "World ID,Name,Num Ports,Networks"},
   261  					{Key: "formatter", Value: "table"},
   262  				},
   263  			},
   264  		},
   265  	},
   266  	{
   267  		CommandInfoItem: esx.CommandInfoItem{Name: "software.vib", DisplayName: "vib", Help: "Install, update, remove, or display individual VIB packages"},
   268  		Method: []esx.CommandInfoMethod{
   269  			{
   270  				CommandInfoItem: esx.CommandInfoItem{Name: "get", DisplayName: "get", Help: "Displays detailed information about one or more installed VIBs on the host and the managed DPU(s)."},
   271  				Param: []esx.CommandInfoParam{
   272  					{
   273  						CommandInfoItem: esx.CommandInfoItem{Name: "rebootingimage", DisplayName: "rebooting-image", Help: "Displays information for the ESXi image which becomes active after a reboot, or nothing if the pending-reboot image has not been created yet. If not specified, information from the current ESXi image in memory will be returned."},
   274  						Aliases:         []string{"--rebooting-image"},
   275  						Flag:            true,
   276  					},
   277  					{
   278  						CommandInfoItem: esx.CommandInfoItem{Name: "vibname", DisplayName: "vibname", Help: "Specifies one or more installed VIBs to display more information about. If this option is not specified, then all of the installed VIBs will be displayed. Must be one of the following forms: name, name:version, vendor:name, or vendor:name:version."},
   279  						Aliases:         []string{"-n", "--vibname"},
   280  						Flag:            false,
   281  					},
   282  				},
   283  				Hints: esx.CommandInfoHints{
   284  					{Key: "fields:VIBExt", Value: "Name,Version,Type,Vendor,Acceptance Level,Summary,Description,ReferenceURLs,Creation Date,Depends,Conflicts,Replaces,Provides,Maintenance Mode Required,Hardware Platforms Required,Live Install Allowed,Live Remove Allowed,Stateless Ready,Overlay,Tags,Payloads,Platforms"},
   285  					{Key: "formatter", Value: "simple"},
   286  					{Key: "header:VIBExt", Value: "%ID%"},
   287  				},
   288  			},
   289  			{
   290  				CommandInfoItem: esx.CommandInfoItem{Name: "install", DisplayName: "install", Help: "Installs VIB packages from a URL or depot. VIBs may be installed, upgraded, or downgraded. WARNING: If your installation requires a reboot, you need to disable HA first."},
   291  				Param: []esx.CommandInfoParam{
   292  					{
   293  						CommandInfoItem: esx.CommandInfoItem{Name: "depot", DisplayName: "depot", Help: "Specifies full remote URLs of the depot index.xml or server file path pointing to an offline bundle .zip file."},
   294  						Aliases:         []string{"-d", "--depot"},
   295  						Flag:            false,
   296  					},
   297  					{
   298  						CommandInfoItem: esx.CommandInfoItem{Name: "dryrun", DisplayName: "dry-run", Help: "Performs a dry-run only. Report the VIB-level operations that would be performed, but do not change anything in the system."},
   299  						Aliases:         []string{"--dry-run"},
   300  						Flag:            true,
   301  					},
   302  					{
   303  						CommandInfoItem: esx.CommandInfoItem{Name: "force", DisplayName: "force", Help: "Bypasses checks for package dependencies, conflicts, obsolescence, and acceptance levels. Really not recommended unless you know what you are doing. Use of this option will result in a warning being displayed in vSphere Web Client.  Use this option only when instructed to do so by VMware Technical Support."},
   304  						Aliases:         []string{"-f", "--force"},
   305  						Flag:            true,
   306  					},
   307  					{
   308  						CommandInfoItem: esx.CommandInfoItem{Name: "maintenancemode", DisplayName: "maintenance-mode", Help: "Pretends that maintenance mode is in effect. Otherwise, installation will stop for live installs that require maintenance mode. This flag has no effect for reboot required remediations."},
   309  						Aliases:         []string{"--maintenance-mode"},
   310  						Flag:            true,
   311  					},
   312  					{
   313  						CommandInfoItem: esx.CommandInfoItem{Name: "noliveinstall", DisplayName: "no-live-install", Help: "Forces an install to /altbootbank even if the VIBs are eligible for live installation or removal. Will cause installation to be skipped on PXE-booted hosts."},
   314  						Aliases:         []string{"--no-live-install"},
   315  						Flag:            true,
   316  					},
   317  					{
   318  						CommandInfoItem: esx.CommandInfoItem{Name: "nosigcheck", DisplayName: "no-sig-check", Help: "Bypasses acceptance level verification, including signing. Use of this option poses a large security risk and will result in a SECURITY ALERT warning being displayed in vSphere Web Client."},
   319  						Aliases:         []string{"--no-sig-check"},
   320  						Flag:            true,
   321  					},
   322  					{
   323  						CommandInfoItem: esx.CommandInfoItem{Name: "proxy", DisplayName: "proxy", Help: "Specifies a proxy server to use for HTTP, FTP, and HTTPS connections. The format is proxy-url:port."},
   324  						Aliases:         []string{"--proxy"},
   325  						Flag:            false,
   326  					},
   327  					{
   328  						CommandInfoItem: esx.CommandInfoItem{Name: "vibname", DisplayName: "vibname", Help: "Specifies VIBs from a depot, using one of the following forms: name, name:version, vendor:name, or vendor:name:version."},
   329  						Aliases:         []string{"-n", "--vibname"},
   330  						Flag:            false,
   331  					},
   332  					{
   333  						CommandInfoItem: esx.CommandInfoItem{Name: "viburl", DisplayName: "viburl", Help: "Specifies one or more URLs to VIB packages to install. http:, https:, ftp:, and file: are all supported. If 'file:' is used, then the file path must be an absolute path on the ESXi host."},
   334  						Aliases:         []string{"-v", "--viburl"},
   335  						Flag:            false,
   336  					},
   337  				},
   338  				Hints: esx.CommandInfoHints{
   339  					{Key: "fields:DpuInstallationResult", Value: "DPU ID,Message,VIBs Installed,VIBs Removed,VIBs Skipped"},
   340  					{Key: "fields:InstallationResult", Value: "Message,VIBs Installed,VIBs Removed,VIBs Skipped,Reboot Required,DPU Results"},
   341  					{Key: "formatter", Value: "simple"},
   342  					{Key: "header:InstallationResult", Value: "Installation Result"},
   343  				},
   344  			},
   345  			{
   346  				CommandInfoItem: esx.CommandInfoItem{Name: "list", DisplayName: "list", Help: "Lists the installed VIB packages on the host and the managed DPU(s)."},
   347  				Param: []esx.CommandInfoParam{
   348  					{
   349  						CommandInfoItem: esx.CommandInfoItem{Name: "rebootingimage", DisplayName: "rebooting-image", Help: "Displays information for the ESXi image which becomes active after a reboot, or nothing if the pending-reboot image has not been created yet. If not specified, information from the current ESXi image in memory will be returned."},
   350  						Aliases:         []string{"--rebooting-image"},
   351  						Flag:            true,
   352  					},
   353  				},
   354  				Hints: esx.CommandInfoHints{
   355  					{Key: "fields:VIBSummaryExt", Value: "Name,Version,Vendor,Acceptance Level,Install Date,Platforms"},
   356  					{Key: "formatter", Value: "table"},
   357  					{Key: "header:VIBSummaryExt", Value: "%ID%"},
   358  					{Key: "show-header", Value: "true"},
   359  					{Key: "table-columns", Value: "Name,Version,Vendor,Acceptance Level,Install Date,Platforms"},
   360  				},
   361  			},
   362  			{
   363  				CommandInfoItem: esx.CommandInfoItem{Name: "remove", DisplayName: "remove", Help: "Removes VIB packages from the host. WARNING: If your installation requires a reboot, you need to disable HA first."},
   364  				Param: []esx.CommandInfoParam{
   365  					{
   366  						CommandInfoItem: esx.CommandInfoItem{Name: "dryrun", DisplayName: "dry-run", Help: "Performs a dry-run only. Report the VIB-level operations that would be performed, but do not change anything in the system."},
   367  						Aliases:         []string{"--dry-run"},
   368  						Flag:            true,
   369  					},
   370  					{
   371  						CommandInfoItem: esx.CommandInfoItem{Name: "force", DisplayName: "force", Help: "Bypasses checks for package dependencies, conflicts, obsolescence, and acceptance levels. Really not recommended unless you know what you are doing. Use of this option will result in a warning being displayed in vSphere Web Client.  Use this option only when instructed to do so by VMware Technical Support."},
   372  						Aliases:         []string{"-f", "--force"},
   373  						Flag:            true,
   374  					},
   375  					{
   376  						CommandInfoItem: esx.CommandInfoItem{Name: "maintenancemode", DisplayName: "maintenance-mode", Help: "Pretends that maintenance mode is in effect. Otherwise, remove will stop for live removes that require maintenance mode. This flag has no effect for reboot required remediations."},
   377  						Aliases:         []string{"--maintenance-mode"},
   378  						Flag:            true,
   379  					},
   380  					{
   381  						CommandInfoItem: esx.CommandInfoItem{Name: "noliveinstall", DisplayName: "no-live-install", Help: "Forces an remove to /altbootbank even if the VIBs are eligible for live removal. Will cause installation to be skipped on PXE-booted hosts."},
   382  						Aliases:         []string{"--no-live-install"},
   383  						Flag:            true,
   384  					},
   385  					{
   386  						CommandInfoItem: esx.CommandInfoItem{Name: "vibname", DisplayName: "vibname", Help: "Specifies one or more VIBs on the host to remove. Must be one of the following forms: name, name:version, vendor:name, vendor:name:version."},
   387  						Aliases:         []string{"-n", "--vibname"},
   388  						Flag:            false,
   389  					},
   390  				},
   391  				Hints: esx.CommandInfoHints{
   392  					{Key: "fields:DpuInstallationResult", Value: "DPU ID,Message,VIBs Installed,VIBs Removed,VIBs Skipped"},
   393  					{Key: "fields:InstallationResult", Value: "Message,VIBs Installed,VIBs Removed,VIBs Skipped,Reboot Required,DPU Results"},
   394  					{Key: "formatter", Value: "simple"},
   395  					{Key: "header:InstallationResult", Value: "Removal Result"},
   396  				},
   397  			},
   398  			{
   399  				CommandInfoItem: esx.CommandInfoItem{Name: "update", DisplayName: "update", Help: "Update installed VIBs to newer VIB packages. No new VIBs will be installed, only updates. WARNING: If your installation requires a reboot, you need to disable HA first."},
   400  				Param: []esx.CommandInfoParam{
   401  					{
   402  						CommandInfoItem: esx.CommandInfoItem{Name: "depot", DisplayName: "depot", Help: "Specifies full remote URLs of the depot index.xml or server file path pointing to an offline bundle .zip file."},
   403  						Aliases:         []string{"-d", "--depot"},
   404  						Flag:            false,
   405  					},
   406  					{
   407  						CommandInfoItem: esx.CommandInfoItem{Name: "dryrun", DisplayName: "dry-run", Help: "Performs a dry-run only. Report the VIB-level operations that would be performed, but do not change anything in the system."},
   408  						Aliases:         []string{"--dry-run"},
   409  						Flag:            true,
   410  					},
   411  					{
   412  						CommandInfoItem: esx.CommandInfoItem{Name: "force", DisplayName: "force", Help: "Bypasses checks for package dependencies, conflicts, obsolescence, and acceptance levels. Really not recommended unless you know what you are doing.  Use of this option will result in a warning being displayed in vSphere Web Client.  Use this option only when instructed to do so by VMware Technical Support."},
   413  						Aliases:         []string{"-f", "--force"},
   414  						Flag:            true,
   415  					},
   416  					{
   417  						CommandInfoItem: esx.CommandInfoItem{Name: "maintenancemode", DisplayName: "maintenance-mode", Help: "Pretends that maintenance mode is in effect. Otherwise, installation will stop for live installs that require maintenance mode. This flag has no effect for reboot required remediations."},
   418  						Aliases:         []string{"--maintenance-mode"},
   419  						Flag:            true,
   420  					},
   421  					{
   422  						CommandInfoItem: esx.CommandInfoItem{Name: "noliveinstall", DisplayName: "no-live-install", Help: "Forces an install to /altbootbank even if the VIBs are eligible for live installation or removal. Will cause installation to be skipped on PXE-booted hosts."},
   423  						Aliases:         []string{"--no-live-install"},
   424  						Flag:            true,
   425  					},
   426  					{
   427  						CommandInfoItem: esx.CommandInfoItem{Name: "nosigcheck", DisplayName: "no-sig-check", Help: "Bypasses acceptance level verification, including signing. Use of this option poses a large security risk and will result in a SECURITY ALERT warning being displayed in vSphere Web Client."},
   428  						Aliases:         []string{"--no-sig-check"},
   429  						Flag:            true,
   430  					},
   431  					{
   432  						CommandInfoItem: esx.CommandInfoItem{Name: "proxy", DisplayName: "proxy", Help: "Specifies a proxy server to use for HTTP, FTP, and HTTPS connections. The format is proxy-url:port."},
   433  						Aliases:         []string{"--proxy"},
   434  						Flag:            false,
   435  					},
   436  					{
   437  						CommandInfoItem: esx.CommandInfoItem{Name: "vibname", DisplayName: "vibname", Help: "Specifies VIBs from a depot, using one of the following forms: name, name:version, vendor:name, or vendor:name:version. VIB packages which are not updates will be skipped."},
   438  						Aliases:         []string{"-n", "--vibname"},
   439  						Flag:            false,
   440  					},
   441  					{
   442  						CommandInfoItem: esx.CommandInfoItem{Name: "viburl", DisplayName: "viburl", Help: "Specifies one or more URLs to VIB packages to update to. http:, https:, ftp:, and file: are all supported. VIB packages which are not updates will be skipped."},
   443  						Aliases:         []string{"-v", "--viburl"},
   444  						Flag:            false,
   445  					},
   446  				},
   447  				Hints: esx.CommandInfoHints{
   448  					{Key: "fields:DpuInstallationResult", Value: "DPU ID,Message,VIBs Installed,VIBs Removed,VIBs Skipped"},
   449  					{Key: "fields:InstallationResult", Value: "Message,VIBs Installed,VIBs Removed,VIBs Skipped,Reboot Required,DPU Results"},
   450  					{Key: "formatter", Value: "simple"},
   451  					{Key: "header:InstallationResult", Value: "Installation Result"},
   452  				},
   453  			},
   454  		},
   455  	},
   456  	{
   457  		CommandInfoItem: esx.CommandInfoItem{Name: "system.hostname", DisplayName: "hostname", Help: "Operations pertaining the network name of the ESX host."},
   458  		Method: []esx.CommandInfoMethod{
   459  			{
   460  				CommandInfoItem: esx.CommandInfoItem{Name: "get", DisplayName: "get", Help: "Get the host, domain or fully qualified name of the ESX host."},
   461  				Param:           nil,
   462  				Hints: esx.CommandInfoHints{
   463  					{Key: "formatter", Value: "simple"},
   464  				},
   465  			},
   466  			{
   467  				CommandInfoItem: esx.CommandInfoItem{Name: "set", DisplayName: "set", Help: "This command allows the user to set the hostname, domain name or fully qualified domain name of the ESX host."},
   468  				Param: []esx.CommandInfoParam{
   469  					{
   470  						CommandInfoItem: esx.CommandInfoItem{Name: "domain", DisplayName: "domain", Help: "The domain name to set for the ESX host. This option is mutually exclusive with the --fqdn option."},
   471  						Aliases:         []string{"-d", "--domain"},
   472  						Flag:            false,
   473  					},
   474  					{
   475  						CommandInfoItem: esx.CommandInfoItem{Name: "fqdn", DisplayName: "fqdn", Help: "Set the fully qualified domain name of the ESX host."},
   476  						Aliases:         []string{"-f", "--fqdn"},
   477  						Flag:            false,
   478  					},
   479  					{
   480  						CommandInfoItem: esx.CommandInfoItem{Name: "host", DisplayName: "host", Help: "The host name to set for the ESX host. This name should not contain the DNS domain name of the host and can only contain letters, numbers and '-'. NOTE this is not the fully qualified name, that can be set with the --fqdn option. This option is mutually exclusive with the --fqdn option."},
   481  						Aliases:         []string{"-H", "--host"},
   482  						Flag:            false,
   483  					},
   484  				},
   485  				Hints: esx.CommandInfoHints{
   486  					{Key: "formatter", Value: ""},
   487  				},
   488  			},
   489  		},
   490  	},
   491  	{
   492  		CommandInfoItem: esx.CommandInfoItem{Name: "system.settings.advanced", DisplayName: "advanced", Help: "The advanced settings are a set of VMkernel options that specific configuration settings to be modified. These options are typically in place for specific workarounds or debugging."},
   493  		Method: []esx.CommandInfoMethod{
   494  			{
   495  				CommandInfoItem: esx.CommandInfoItem{Name: "add", DisplayName: "add", Help: "Add a user defined advanced option to the /UserVars/ advanced option tree."},
   496  				Param: []esx.CommandInfoParam{
   497  					{
   498  						CommandInfoItem: esx.CommandInfoItem{Name: "description", DisplayName: "description", Help: "Description of the new option."},
   499  						Aliases:         []string{"-d", "--description"},
   500  						Flag:            false,
   501  					},
   502  					{
   503  						CommandInfoItem: esx.CommandInfoItem{Name: "hidden", DisplayName: "hidden", Help: "Whether the option is hidden."},
   504  						Aliases:         []string{"-H", "--hidden"},
   505  						Flag:            true,
   506  					},
   507  					{
   508  						CommandInfoItem: esx.CommandInfoItem{Name: "hostspecific", DisplayName: "host-specific", Help: "This indicates that the value of this option is always unique to a host."},
   509  						Aliases:         []string{"-O", "--host-specific"},
   510  						Flag:            true,
   511  					},
   512  					{
   513  						CommandInfoItem: esx.CommandInfoItem{Name: "impact", DisplayName: "impact", Help: "This specifies the impact on the host when the value of the option is modified: \n    maintenance-mode: This indicates that the host must be in maintenance mode before the option value is modified.\n    reboot: This indicates that the host must be rebooted for the option value to take effect.\n"},
   514  						Aliases:         []string{"-I", "--impact"},
   515  						Flag:            false,
   516  					},
   517  					{
   518  						CommandInfoItem: esx.CommandInfoItem{Name: "intdefault", DisplayName: "int-default", Help: "The default value of the new option (integer option only, required)."},
   519  						Aliases:         []string{"-i", "--int-default"},
   520  						Flag:            false,
   521  					},
   522  					{
   523  						CommandInfoItem: esx.CommandInfoItem{Name: "max", DisplayName: "max", Help: "The maximum allowed value (integer option only, required)."},
   524  						Aliases:         []string{"-M", "--max"},
   525  						Flag:            false,
   526  					},
   527  					{
   528  						CommandInfoItem: esx.CommandInfoItem{Name: "min", DisplayName: "min", Help: "The minimum allowed value (integer option only, required)."},
   529  						Aliases:         []string{"-m", "--min"},
   530  						Flag:            false,
   531  					},
   532  					{
   533  						CommandInfoItem: esx.CommandInfoItem{Name: "option", DisplayName: "option", Help: "The name of the new option. Valid characters: letters, digits and underscore."},
   534  						Aliases:         []string{"-o", "--option"},
   535  						Flag:            false,
   536  					},
   537  					{
   538  						CommandInfoItem: esx.CommandInfoItem{Name: "stringdefault", DisplayName: "string-default", Help: "The default value of the new option (string option only). An empty string is assumed if not specified."},
   539  						Aliases:         []string{"-s", "--string-default"},
   540  						Flag:            false,
   541  					},
   542  					{
   543  						CommandInfoItem: esx.CommandInfoItem{Name: "type", DisplayName: "type", Help: "The type of the new option. Supported values: \n    integer: Advanced option with integer value.\n    string: Advanced option with string value.\n"},
   544  						Aliases:         []string{"-t", "--type"},
   545  						Flag:            false,
   546  					},
   547  				},
   548  				Hints: esx.CommandInfoHints{
   549  					{Key: "formatter", Value: ""},
   550  				},
   551  			},
   552  			{
   553  				CommandInfoItem: esx.CommandInfoItem{Name: "list", DisplayName: "list", Help: "List the advanced options available from the VMkernel."},
   554  				Param: []esx.CommandInfoParam{
   555  					{
   556  						CommandInfoItem: esx.CommandInfoItem{Name: "delta", DisplayName: "delta", Help: "Only display options whose values differ from their default."},
   557  						Aliases:         []string{"-d", "--delta"},
   558  						Flag:            true,
   559  					},
   560  					{
   561  						CommandInfoItem: esx.CommandInfoItem{Name: "option", DisplayName: "option", Help: "Only get the information for a single VMkernel advanced option."},
   562  						Aliases:         []string{"-o", "--option"},
   563  						Flag:            false,
   564  					},
   565  					{
   566  						CommandInfoItem: esx.CommandInfoItem{Name: "tree", DisplayName: "tree", Help: "Limit the list of advanced option to a specific sub tree."},
   567  						Aliases:         []string{"-t", "--tree"},
   568  						Flag:            false,
   569  					},
   570  				},
   571  				Hints: esx.CommandInfoHints{
   572  					{Key: "fields:SettingsAdvancedOption", Value: "Path,Type,Int Value,Default Int Value,Min Value,Max Value,String Value,Default String Value,Valid Characters,Description,Host Specific,Impact"},
   573  					{Key: "formatter", Value: "simple"},
   574  				},
   575  			},
   576  			{
   577  				CommandInfoItem: esx.CommandInfoItem{Name: "remove", DisplayName: "remove", Help: "Remove a user defined advanced option from the /UserVars/ advanced option tree."},
   578  				Param: []esx.CommandInfoParam{
   579  					{
   580  						CommandInfoItem: esx.CommandInfoItem{Name: "option", DisplayName: "option", Help: "The name of the option to remove (without the /UserVars/ prefix as it is implied)."},
   581  						Aliases:         []string{"-o", "--option"},
   582  						Flag:            false,
   583  					},
   584  				},
   585  				Hints: esx.CommandInfoHints{
   586  					{Key: "formatter", Value: ""},
   587  				},
   588  			},
   589  			{
   590  				CommandInfoItem: esx.CommandInfoItem{Name: "set", DisplayName: "set", Help: "Set the value of an advanced option."},
   591  				Param: []esx.CommandInfoParam{
   592  					{
   593  						CommandInfoItem: esx.CommandInfoItem{Name: "default", DisplayName: "default", Help: "Reset the option to its default value."},
   594  						Aliases:         []string{"-d", "--default"},
   595  						Flag:            true,
   596  					},
   597  					{
   598  						CommandInfoItem: esx.CommandInfoItem{Name: "intvalue", DisplayName: "int-value", Help: "If the option is an integer value use this option."},
   599  						Aliases:         []string{"-i", "--int-value"},
   600  						Flag:            false,
   601  					},
   602  					{
   603  						CommandInfoItem: esx.CommandInfoItem{Name: "option", DisplayName: "option", Help: "The name of the option to set the value of. Example: \"/Misc/HostName\""},
   604  						Aliases:         []string{"-o", "--option"},
   605  						Flag:            false,
   606  					},
   607  					{
   608  						CommandInfoItem: esx.CommandInfoItem{Name: "stringvalue", DisplayName: "string-value", Help: "If the option is a string use this option."},
   609  						Aliases:         []string{"-s", "--string-value"},
   610  						Flag:            false,
   611  					},
   612  				},
   613  				Hints: esx.CommandInfoHints{
   614  					{Key: "formatter", Value: ""},
   615  				},
   616  			},
   617  		},
   618  	},
   619  	{
   620  		CommandInfoItem: esx.CommandInfoItem{Name: "system.stats.uptime", DisplayName: "uptime", Help: "System uptime, in microseconds"},
   621  		Method: []esx.CommandInfoMethod{
   622  			{
   623  				CommandInfoItem: esx.CommandInfoItem{Name: "get", DisplayName: "get", Help: "Display the number of microseconds the system has been running."},
   624  				Param:           nil,
   625  				Hints: esx.CommandInfoHints{
   626  					{Key: "formatter", Value: "simple"},
   627  				},
   628  			},
   629  		},
   630  	},
   631  	{
   632  		CommandInfoItem: esx.CommandInfoItem{Name: "vm.process", DisplayName: "process", Help: "Operations on running virtual machine processes"},
   633  		Method: []esx.CommandInfoMethod{
   634  			{
   635  				CommandInfoItem: esx.CommandInfoItem{Name: "kill", DisplayName: "kill", Help: "Used to forcibly kill Virtual Machines that are stuck and not responding to normal stop operations."},
   636  				Param: []esx.CommandInfoParam{
   637  					{
   638  						CommandInfoItem: esx.CommandInfoItem{Name: "type", DisplayName: "type", Help: "The type of kill operation to attempt. There are three types of VM kills that can be attempted: [soft, hard, force]. Users should always attempt 'soft' kills first, which will give the VMX process a chance to shutdown cleanly (like kill or kill -SIGTERM). If that does not work move to 'hard' kills which will shutdown the process immediately (like kill -9 or kill -SIGKILL). 'force' should be used as a last resort attempt to kill the VM. If all three fail then a reboot is required."},
   639  						Aliases:         []string{"-t", "--type"},
   640  						Flag:            false,
   641  					},
   642  					{
   643  						CommandInfoItem: esx.CommandInfoItem{Name: "worldid", DisplayName: "world-id", Help: "The World ID of the Virtual Machine to kill. This can be obtained from the 'vm process list' command"},
   644  						Aliases:         []string{"-w", "--world-id"},
   645  						Flag:            false,
   646  					},
   647  				},
   648  				Hints: esx.CommandInfoHints{
   649  					{Key: "formatter", Value: ""},
   650  				},
   651  			},
   652  			{
   653  				CommandInfoItem: esx.CommandInfoItem{Name: "list", DisplayName: "list", Help: "List the virtual machines on this system. This command currently will only list running VMs on the system."},
   654  				Param:           nil,
   655  				Hints: esx.CommandInfoHints{
   656  					{Key: "fields:VirtualMachine", Value: "World ID,Process ID,VMX Cartel ID,UUID,Display Name,Config File"},
   657  					{Key: "formatter", Value: "simple"},
   658  					{Key: "header:VirtualMachine", Value: "%Display Name%"},
   659  				},
   660  			},
   661  		},
   662  	},
   663  }