6.0.1
Table Of Contents
- vCenter Server Appliance Configuration
- Contents
- About vCenter Server Appliance Configuration
- Updated Information
- vCenter Server Appliance Overview
- Using the Appliance Management Interface to Configure the vCenter Server Appliance
- Log In to the vCenter Server Appliance Management Interface
- View the vCenter Server Appliance Health Status
- Reboot or Shut Down the vCenter Server Appliance
- Export a Support Bundle
- Enable or Disable SSH and Bash Shell Access
- Configure the DNS, IP Address, and Proxy Settings
- Configure the System Time Zone and Time Synchronization Settings
- Change the Password and Password Expiration Settings of the Root User
- Using the vSphere Web Client to Configure the vCenter Server Appliance
- Join the vCenter Server Appliance to an Active Directory Domain
- Leave an Active Directory Domain
- Add a User to the SystemConfiguration.BashShellAdministrators Group
- Edit Access Settings to the vCenter Server Appliance
- Edit the DNS and IP Address Settings of the vCenter Server Appliance
- Edit the Firewall Settings of the vCenter Server Appliance
- Edit the Startup Settings of a Service
- Start, Stop, or Restart Services in the vCenter Server Appliance
- View the Health Status of Services and Nodes
- Edit the Settings of Services
- Export a Support Bundle
- Redirect vCenter Server Appliance Log Files to Another Machine
- Using the Appliance Shell to Configure the vCenter Server Appliance
- Access the Appliance Shell
- Enable Bash Shell Access From the Appliance Shell
- Keyboard Shortcuts for Editing Commands
- Get Help About the Plug-Ins and API Commands in the Appliance
- Plug-Ins in the vCenter Server Appliance Shell
- API Commands in the vCenter Server Appliance Shell
- Browse the Log Files by Using the showlog Plug-In
- Configuring SNMP for the vCenter Server Appliance
- Configuring Time Synchronization Settings in the vCenter Server Appliance
- Managing Local User Accounts in the vCenter Server Appliance
- User Roles in the vCenter Server Appliance
- Get a List of the Local User Accounts in the vCenter Server Appliance
- Create a Local User Account in the vCenter Server Appliance
- Update the Password of a Local User in the vCenter Server Appliance
- Update a Local User Account in the vCenter Server Appliance
- Delete a Local User Account in the vCenter Server Appliance
- Monitor Health Status and Statistics in the vCenter Server Appliance
- Using the vimtop Plug-In to Monitor the Resource Usage of Services
- Using the Direct Console User Interface to Configure the vCenter Server Appliance
- Log In to the Direct Console User Interface
- Change the Password of the Root User
- Configure the Management Network of the vCenter Server Appliance
- Restart the Management Network of the vCenter Server Appliance
- Enable Access to the Appliance Bash shell
- Access the Appliance Bash Shell for Troubleshooting
- Export a vCenter Server Support Bundle for Troubleshooting
- Index
API Commands in the vCenter Server Appliance Shell
The API commands in the vCenter Server Appliance let you perform various administrative tasks in the
vCenter Server Appliance. The API commands are provided by appliance management service in the
vCenter Server Appliance. You can edit time synchronization seings, monitor processes and services, set
up the SNMP seings, and so on.
Table 4‑3. API Commands Available in the vCenter Server Appliance
API Command Description
com.vmware.appliance.version1.access.consolecli.get
Get information about the state of the
console-based controlled CLI (TTY1).
com.vmware.appliance.version1.access.consolecli.set
Set enabled state of console-based
controlled CLI (TTY1).
com.vmware.appliance.version1.access.dcui.get
Get information about the state of the
Direct Console User Interface (DCUI
TTY2).
com.vmware.appliance.version1.access.dcui.set
Set enabled state of the Direct Console
User Interface (DCUI TTY2).
com.vmware.appliance.version1.access.shell.get
Get information about the state of Bash
shell, that is, access to Bash shell from
within the controlled CLI.
com.vmware.appliance.version1.access.shell.set
Set enabled state of Bash shell, that is,
access to Bash shell from within the
controlled CLI.
com.vmware.appliance.version1.access.ssh.get
Get enabled state of the SSH-based
controlled CLI.
com.vmware.appliance.version1.access.ssh.set
Set enabled state of the SSH-based
controlled CLI.
com.vmware.appliance.version1.localaccounts.user.add
Create a new local user account.
com.vmware.appliance.version1.localaccounts.user.delete
Delete a local user account.
com.vmware.appliance.version1.localaccounts.user.get
Get the local user account information.
com.vmware.appliance.version1.localaccounts.user.list
List local user accounts .
com.vmware.appliance.version1.localaccounts.user.password.updat
e
Update the password of a logged in
user or of the user that you specify in
the username parameter.
com.vmware.appliance.version1.localaccounts.user.set
Update local user account properties,
such as role, full name, enabled status,
and password.
com.vmware.appliance.version1.monitoring.snmp.disable
Stop an enabled SNMP agent.
com.vmware.appliance.version1.monitoring.snmp.enable
Start a disabled SNMP agent.
com.vmware.appliance.version1.monitoring.snmp.get
Return an SNMP agent conguration.
com.vmware.appliance.version1.monitoring.snmp.hash
Generate localized keys for secure
SNMPv3 communications.
com.vmware.appliance.version1.monitoring.snmp.limits
Get SNMP limits information.
com.vmware.appliance.version1.monitoring.snmp.reset
Restore seings to factory defaults.
com.vmware.appliance.version1.monitoring.snmp.set
Set SNMP conguration.
com.vmware.appliance.version1.monitoring.snmp.test
Send a warmStart notication to all
congured traps and inform
destinations (see RFC 3418).
Chapter 4 Using the Appliance Shell to Configure the vCenter Server Appliance
VMware, Inc. 33