Machine Configuration Options¶
On this page
Note
Groups and projects are synonymous terms. Your {GROUP-ID}
is the
same as your project id. For existing groups, your group/project id
remains the same. This page uses the more familiar term group when
referring to descriptions. The endpoint remains as stated in the
document.
The machineConfigOptions
resource displays the cloud service providers you
have integrated with Ops Manager and provides endpoints to retrieve the available
configuration options for a provider.
For more information on Ops Manager integration with cloud service providers, see Provision Servers.
Base URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Endpoints¶
Get Endpoints for Available Cloud Service Providers¶
This returns the endpoints of the service providers for which you can retrieve configuration options.
Get Machine Configurations Options for a Service Provider¶
PROVIDER-NAME
is a service provider. See
Get Endpoints for Available Cloud Service Providers.
Get Machine Configurations Options for a Service Provider and Region¶
PROVIDER-NAME
is a service provider. See
Get Endpoints for Available Cloud Service Providers. REGION
is a
region value for that service provider.
Sample Entity¶
When you retrieve the configuration options for a service provider, the
returned entity will include all available configuration options for your
integration with that provider. For example, for AWS, the hvmInstanceTypes
array contains an object for every available AWS instance type.
The following is an example entity for an AWS machine configuration.
Entity Fields¶
The following table describes the top-level fields returned when for an AWS machine configuration. For fuller descriptions of the AWS options, please see the AWS Documentation.
Name | Type | Description |
---|---|---|
availabilityZoneNames | string array | Lists AWS availability zones. |
availableRegionNames | string array | Lists regions within AWS availability zones. |
fileSystemTypeNames | string array | The file system used for storing files on disk. |
hvmInstanceTypes | object array | The available hardware virtual machines (HVM). |
machineImages | object array | The available Amazon machine images (AMI). |
maxIOPS | number | The maximum input/output operations per second. |
maxRootVolSizeGB | number | Defines the upper limit of the root volume size. |
minIOPS | number | The minimum input/output operations per second. |
minRootVolSizeGB | number | Defines the lower limit of the root volume size. |
possibleVolumeNames | string array | Available devices names for attached storage. |
pvInstanceTypes | object array | The available paravirtual (PV) instances. |
regionHasEC2Classic |
Boolean | Indicates whether the region supports the EC2-Classic platform. |
securityGroups | object array | The available AWS security groups, used for setting firewall rules. |
sshKeys | object array | The public keys available to provision new AWS instances. |
vpcs | object array | The available AWS virtual private clouds. |
Links¶
Relation | Description |
---|---|
self | Me. |
http://mms.mongodb.com/group |
The group the machine configuration options belongs to. |
http://mms.mongodb.com/machineConfigOptions |
The cloud service provider. |
Examples¶
Response Header¶
Response Body¶
Get Machine Configurations Options for a Given Provider¶
The following retrieves the machine configuration options for Amazon Web Services.
Request¶
Response¶
Response Header¶
Response Body¶
Get Machine Configurations Options for a Given Provider and Region¶
The following retrieves the machine configuration options for Amazon Web Services for the AWS_US_WEST_1
region.
Request¶
Response¶
The following example shows only the top-level fields of the return document.