×
 
 
  •  
$helper.renderConfluenceMacro('{bmc-global-announcement:$space.key}')
TrueSight Orchestration Content 20.19.01 ... Application adapters Amazon EC2 REST adapter Amazon EC2 REST actor adapter requests and responses

Windows_Operations for the Amazon EC2 REST adapter

The following topic describes the adapter request and response for the Windows_Operations. 

Bundle Instance operation

The Bundle Instance operation bundles a Windows instance. During bundling, only the root store is bundled. Data on other instance stores is not preserved. This procedure is not applicable to Linux, UNIX, or Windows instances that use Amazon EBS volumes as their root devices. 

The following figure shows a sample <items> XML element for the Bundle Instance operation. 

Sample <items> XML element for the Bundle Instance operation

<items>
    <item>
        <parameters>
            <instance-id></instance-id>
            <storage>
                <S3>
                    <bucket></bucket>
                    <prefix></prefix>
                    <aws-access-key-id></aws-access-key-id>
                    <secret-access-key></secret-access-key>
                    <expiration-time></expiration-time>
                </S3>
            </storage>
        </parameters>
    </item>
</items>


The following table describes the adapter request elements for this request. 

Adapter request elements for the Bundle Instance operation

Element

Definition

Required

<access-key>

Specifies the Amazon Web Services (AWS) access key

You need to generate the AWS access key by going to the Security Credentials tab in the AWS console.

Conditional;

  • You must specify the Access Key and theSecret Key together in the configuration or the adapter request.
  • If you specify both the keys in the adapter request and in the adapter configuration, the key values in the request override the values in the configuration.
  • If only the Access Key is specified, the adapter ignores the value.
<secret-key>

Specifies the AWS secret access key

You need to generate the AWS secret access key by going to the Security Credentials tab in the AWS console.

Conditional;

  • You must specify the Access Key and theSecret Key together in the configuration or the adapter request.
  • If you specify both the keys in the adapter request and in the adapter configuration, the key values in the request override the values in the configuration.
  • If only the Secret Access Key is specified, the adapter ignores the value.
<region>

Specifies the region with which you want the adapter to communicate

Amazon EC2 is hosted in multiple locations world-wide. You must specify the region in which you want the adapter to perform the actions.

Valid values:

  • us-east-1
  • us-west-2 (default)
  • us-west-1
  • eu-west-1
  • ap-southeast-1
  • ap-northeast-1
  • ap-southeast-2
  • sa-east-1
No

<operation-name>

Contains the name of the operation: bundle-instance

Yes

<instance-id>

Specifies the ID of the instance to bundle

Yes

<bucket>

Specifies the bucket in which the AMI must be stored 
You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.

Yes

<prefix>

Specifies the beginning of the file name of the AMI

Yes

<aws-access-key-id>

Specifies the Access Key ID of the owner of the Amazon S3 bucket

Yes

<secret-access-key>

Specifies the account's secret access key to sign the upload policy

Yes

<expiration-time>

Specifies the expiration time of the upload policy

Recommendation

BMC recommends that you set the <expiration-time> to 12 hours or more.

Yes

The following figure shows a sample adapter request for the Bundle Instance operation. 

Sample adapter request for the Bundle Instance operation

<amazon-ec2-rest-request>
    <operation-name>bundle-instance</operation-name>
    <region>us-east-1</region>
    <parameters>
      <instance-id>i-5e77b170</instance-id>
      <storage>
        <S3>
          <bucket>testbundle</bucket>
          <prefix>pun</prefix>
          <aws-access-key-id>AKIAIKDT5B7HPFDGROKA</aws-access-key-id>
          <secret-access-key>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</secret-access-key>
          <expiration-time>10</expiration-time>
        </S3>
      </storage>
    </parameters>
</amazon-ec2-rest-request>

Note

Based on the parameters that you provide in the <items> XML element, the adapter creates the signature and time-stamp security related elements.

The following figure shows the response for the sample adapter request for the Bundle Instance operation. 

Sample adapter response for the Bundle Instance operation

<amazon-ec2-rest-response>
  <metadata>
    <status>success</status>
  </metadata>
  <BundleInstanceResponse>
    <bundleInstanceTask>
      <instanceId>i-5e77b170</instanceId>
      <bundleId>bun-07242c6d</bundleId>
      <state>pending</state>
      <startTime>Tue Jan 07 00:33:52 EST 2014</startTime>
      <updateTime>Tue Jan 07 00:33:52 EST 2014</updateTime>
      <progress />
      <storage>
        <S3>
          <bucket>testbundle</bucket>
          <prefix>pun</prefix>
        </S3>
      </storage>
    </bundleInstanceTask>
  </BundleInstanceResponse>
</amazon-ec2-rest-response>

 Back to top

Cancel Bundle Tasks operation

The Cancel Bundle Task operation cancels an Amazon EC2 bundling operation. 

The following figure shows a sample <items> XML element for the Cancel Bundle Task operation. 

Sample <items> XML element for the Cancel Bundle Task operation

<items>
    <item>
        <parameters>
            <bundle-id></bundle-id>
        </parameters>
    </item>
</items>

The following table describes the adapter request elements for this request. 

Adapter request elements for the Cancel Bundle Task operation

Element

Definition

Required

<access-key>

Specifies the Amazon Web Services (AWS) access key

You need to generate the AWS access key by going to the Security Credentials tab in the AWS console.

Conditional;

  • You must specify the Access Key and theSecret Key together in the configuration or the adapter request.
  • If you specify both the keys in the adapter request and in the adapter configuration, the key values in the request override the values in the configuration.
  • If only the Access Key is specified, the adapter ignores the value.
<secret-key>

Specifies the AWS secret access key

You need to generate the AWS secret access key by going to the Security Credentials tab in the AWS console.

Conditional;

  • You must specify the Access Key and theSecret Key together in the configuration or the adapter request.
  • If you specify both the keys in the adapter request and in the adapter configuration, the key values in the request override the values in the configuration.
  • If only the Secret Access Key is specified, the adapter ignores the value.
<region>

Specifies the region with which you want the adapter to communicate

Amazon EC2 is hosted in multiple locations world-wide. You must specify the region in which you want the adapter to perform the actions.

Valid values:

  • us-east-1
  • us-west-2 (default)
  • us-west-1
  • eu-west-1
  • ap-southeast-1
  • ap-northeast-1
  • ap-southeast-2
  • sa-east-1
No

<operation-name>

Contains the name of the operation: cancel-bundle-task

Yes

<bundle-id>

Specifies the ID of the bundle task to cancel

Yes

The following figure shows a sample adapter request for the Cancel Bundle Task operation. 

Sample adapter request for the Cancel Bundle Task operation

<amazon-ec2-rest-request>
    <access-key>AKIAI**********GROKA</access-key>
    <secret-key>6hXjoZZDvWx**********1y2Yte/jZfnY6WgKCdC</secret-key>
    <operation-name>cancel-bundle-task</operation-name>
    <region>us-west-2</region>
    <parameters>
      <bundle-id>bun-382c9b0f</bundle-id>
    </parameters>
</amazon-ec2-rest-request>

The following figure shows the response for the sample adapter request for the Cancel Bundle Task operation. 

Sample adapter response for the Cancel Bundle Task operation

<amazon-ec2-rest-response>
  <metadata>
    <status>success</status>
  </metadata>
  <CancelBundleTaskResponse>
    <bundleInstanceTask>
      <instanceId>i-d131a5e7</instanceId>
      <bundleId>bun-382c9b0f</bundleId>
      <state>cancelling</state>
      <startTime>Tue Jan 07 02:00:53 EST 2014</startTime>
      <updateTime>Tue Jan 07 02:21:46 EST 2014</updateTime>
      <progress />
      <storage>
        <S3>
          <bucket>testbundle</bucket>
          <prefix>pun</prefix>
        </S3>
      </storage>
    </bundleInstanceTask>
  </CancelBundleTaskResponse>
</amazon-ec2-rest-response>

 Back to top

Describe Bundle Tasks operation

The Describe Bundle Tasks operation describes the current bundling tasks. Bundling enables AMIs to become the basic unit of deployment that allow you to rapidly boot new custom instances as you need them. 

The following figure shows a sample <items> XML element for the Describe Bundle Tasks operation. 

Sample <items> XML element for the Describe Bundle Tasks operation

<items>
    <item>
        <parameters>
            <bundles-set>
                <!--Zero or more repetition-->
                <item>
                    <bundle-id></bundle-id>
                </item>
            </bundles-set>
        </parameters>
    </item>
</items>

The following table describes the adapter request elements for this request. 

Adapter request elements for the Describe Bundle Tasks operation

Element

Definition

Required

<access-key>

Specifies the Amazon Web Services (AWS) access key

You need to generate the AWS access key by going to the Security Credentials tab in the AWS console.

Conditional;

  • You must specify the Access Key and theSecret Key together in the configuration or the adapter request.
  • If you specify both the keys in the adapter request and in the adapter configuration, the key values in the request override the values in the configuration.
  • If only the Access Key is specified, the adapter ignores the value.
<secret-key>

Specifies the AWS secret access key

You need to generate the AWS secret access key by going to the Security Credentials tab in the AWS console.

Conditional;

  • You must specify the Access Key and theSecret Key together in the configuration or the adapter request.
  • If you specify both the keys in the adapter request and in the adapter configuration, the key values in the request override the values in the configuration.
  • If only the Secret Access Key is specified, the adapter ignores the value.
<region>

Specifies the region with which you want the adapter to communicate

Amazon EC2 is hosted in multiple locations world-wide. You must specify the region in which you want the adapter to perform the actions.

Valid values:

  • us-east-1
  • us-west-2 (default)
  • us-west-1
  • eu-west-1
  • ap-southeast-1
  • ap-northeast-1
  • ap-southeast-2
  • sa-east-1
No

<operation-name>

Contains the name of the operation: describe-bundle-tasks

Yes

<bundles-set>

Specifies the set of bundle tasks to be described

Yes

The following figure shows a sample adapter request for the Describe Bundle Tasks operation. 

Sample adapter request for the Describe Bundle Tasks operation

<amazon-ec2-rest-request>
    <access-key>AKIAI**********DGROKA</access-key>
    <secret-key>6hXjoZZDvWx**********1y2Yte/jZfnY6WgKCdC</secret-key>
    <operation-name>describe-bundle-tasks</operation-name>
    <region>us-east-1</region>
    <parameters>
      <bundles-set>
        <item>
          <bundle-id>bun-07242c6d</bundle-id>
        </item>
      </bundles-set>
    </parameters>
</amazon-ec2-rest-request>

The following figure shows the response for the sample adapter request for the Describe Bundle Tasks operation. 

Sample adapter response for the Describe Bundle Tasks operation

<amazon-ec2-rest-response>
  <metadata>
    <status>success</status>
  </metadata>
  <DescribeBundleTasksResponse>
    <bundleInstanceTasksSet>
      <item>
        <instanceId>i-5e77b170</instanceId>
        <bundleId>bun-07242c6d</bundleId>
        <state>bundling</state>
        <startTime>Tue Jan 07 00:33:52 EST 2014</startTime>
        <updateTime>Tue Jan 07 00:38:15 EST 2014</updateTime>
        <progress>3%</progress>
        <storage>
          <S3>
            <bucket>testbundle</bucket>
            <prefix>pun</prefix>
          </S3>
        </storage>
      </item>
    </bundleInstanceTasksSet>
  </DescribeBundleTasksResponse>
</amazon-ec2-rest-response>

Back to top

Get Password Data operation

The Get Password Data operation enables you to retrieve the administrator password for the instances that are running Microsoft Windows operating systems. 

The Windows password is generated only the first time an Amazon Machine Image (AMI) is launched. The password is not generated for rebundled AMIs or after the password is changed for an instance.

The following figure shows a sample <items> XML element for the Get Password Data operation. 

Sample <items> XML element for the Get Password Data operation

<items>
    <item>
        <parameters>
             <instance-id></instance-id>
         </parameters>
    </item>
</items>

The following table describes the adapter request elements for this request. 

Adapter request elements for the Get Password Data operation

Element

Definition

Required

<access-key>

Specifies the Amazon Web Services (AWS) access key

You need to generate the AWS access key by going to the Security Credentials tab in the AWS console.

Conditional;

  • You must specify the Access Key and theSecret Key together in the configuration or the adapter request.
  • If you specify both the keys in the adapter request and in the adapter configuration, the key values in the request override the values in the configuration.
  • If only the Access Key is specified, the adapter ignores the value.
<secret-key>

Specifies the AWS secret access key

You need to generate the AWS secret access key by going to the Security Credentials tab in the AWS console.

Conditional;

  • You must specify the Access Key and theSecret Key together in the configuration or the adapter request.
  • If you specify both the keys in the adapter request and in the adapter configuration, the key values in the request override the values in the configuration.
  • If only the Secret Access Key is specified, the adapter ignores the value.
<region>

Specifies the region with which you want the adapter to communicate

Amazon EC2 is hosted in multiple locations world-wide. You must specify the region in which you want the adapter to perform the actions.

Valid values:

  • us-east-1
  • us-west-2 (default)
  • us-west-1
  • eu-west-1
  • ap-southeast-1
  • ap-northeast-1
  • ap-southeast-2
  • sa-east-1
No

<operation-name>

Contains the name of the operation: get-password-data

Yes

<instance-id>

Specifies the ID of the instance for which you want to retrieve the password

Yes

The following figure shows a sample adapter request for the Get Password Data operation. 

Sample adapter request for the Get Password Data operation

<amazon-ec2-rest-request>
    <access-key>AKI**************OKA</access-key>
    <secret-key>6hXjo**********qnRwcn1y2Yte/jZfnY6WgKCdC</secret-key>
    <operation-name>get-password-data</operation-name>
    <region>us-west-2</region>
    <parameters>
      <instance-id>i-b08afb86</instance-id>
    </parameters>
</amazon-ec2-rest-request>

The following figure shows the response for the sample adapter request for the Get Password Data operation. 

Sample adapter response for the Get Password Data operation

<amazon-ec2-rest-response>
  <metadata>
    <status>success</status>
  </metadata>
  <GetPasswordDataResponse>
    <instanceId>i-b08afb86</instanceId>
    <timestamp>Fri Jan 10 00:45:14 EST 2014</timestamp>
    <passwordData>
X9l8A+c91r1mSvb+gfh0n3kXm3uNZb5CVB27xseZlv1VrhEoUUwgtcKsOtWG+4j7gOrUUaC4Jl+
bwBvcIBMkB9lXaXMEiT0dR2wT484ohzfjLf81D4PRQTtHqrHlqqY/z4/
sAqU7LzTWn18EP9LAPROcr8uh2iBwcz2RxjIYL1zTffyHToYKGAhQRTu0cJ/
MEc8U6kWn1upv1mVYwlO2+e3sTbEi1mFsOt/Xe/96H2O1GJvb2NZQ4ckx/
MRT7XQGNaw9FTsVDwaHnEKDAvpcBEmyaVAX2k2fdxdRbUMhWYWBpfm/
+0EF7hUAkPvlgaGuHHrnhEfX2Ef64PNU0opBnw==
</passwordData>
  </GetPasswordDataResponse>
</amazon-ec2-rest-response>


Back to top

Was this page helpful? Yes No Submitting... Thank you
Last modified by Shweta Hardikar on May 08, 2018
windows_operations amazon_ec2_rest

Comments

Log in or register to comment.

Describe VPCs operation for the Amazon EC2 REST adapter
Amazon S3 adapter
© Copyright 2013 - 2019 BMC Software, Inc.
Legal notices

Powered by Atlassian Confluence and Scroll Viewport

© Copyright 2005-2024 BMC Software, Inc. Use of this site signifies your acceptance of BMC’s Terms of Use . BMC, the BMC logo, and other BMC marks are assets of BMC Software, Inc. These trademarks are registered and may be registered in the U.S. and in other countries.