Skip to content

Commit

Permalink
Deployed 15a9a78 with MkDocs version: 0.17.3
Browse files Browse the repository at this point in the history
  • Loading branch information
tlindsay42 committed Jun 10, 2018
1 parent dc095ed commit 2bc93d7
Show file tree
Hide file tree
Showing 16 changed files with 74 additions and 76 deletions.
12 changes: 5 additions & 7 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@
<a class="current" href=".">Home</a>
<ul class="subnav">

<li class="toctree-l2"><a href="#armor-powershell-module">Armor PowerShell Module</a></li>
<li class="toctree-l2"><a href="#the-armor-community-powershell-module">The Armor Community PowerShell Module</a></li>


</ul>
Expand Down Expand Up @@ -276,20 +276,18 @@
<div role="main">
<div class="section">

<h1 id="armor-powershell-module">Armor PowerShell Module</h1>
<h1 id="the-armor-community-powershell-module">The Armor Community PowerShell Module</h1>
<p><a href="https://www.powershellgallery.com/packages/Armor"><img alt="Current Version" src="https://img.shields.io/powershellgallery/v/Armor.svg" /></a>
<a href="https://www.powershellgallery.com/packages/Armor"><img alt="Total Downloads" src="https://img.shields.io/powershellgallery/dt/Armor.svg" /></a></p>
<p><a href="https://ci.appveyor.com/project/tlindsay42/ArmorPowerShell/branch/master"><img alt="Build Status" src="https://ci.appveyor.com/api/projects/status/x4ik2enxvdc5h0x6/branch/master?svg=true" /></a>
<a href="https://travis-ci.org/tlindsay42/ArmorPowerShell"><img alt="Build Status" src="https://travis-ci.org/tlindsay42/ArmorPowerShell.svg?branch=master" /></a>
<a href="https://coveralls.io/github/tlindsay42/ArmorPowerShell?branch=master"><img alt="Coverage Status" src="https://coveralls.io/repos/github/tlindsay42/ArmorPowerShell/badge.svg?branch=master" /></a>
<a href="http://armorpowershell.readthedocs.io/en/latest/?badge=latest"><img alt="Documentation Status" src="https://readthedocs.org/projects/armorpowershell/badge/?version=latest" /></a></p>
<p><a href="https://gitter.im/ArmorPowerShell/Lobby?utm_source=badge&amp;utm_medium=badge&amp;utm_campaign=pr-badge&amp;utm_content=badge"><img alt="Join the chat at https://gitter.im/ArmorPowerShell/Lobby" src="https://badges.gitter.im/ArmorPowerShell/Lobby.svg" /></a></p>
<a href="https://gitter.im/ArmorPowerShell/Lobby?utm_source=badge&amp;utm_medium=badge&amp;utm_campaign=pr-badge&amp;utm_content=badge"><img alt="Join the chat at https://gitter.im/ArmorPowerShell/Lobby" src="https://badges.gitter.im/ArmorPowerShell/Lobby.svg" /></a></p>
<p>This is a community project that provides a powerful command-line interface for managing and monitoring your <strong><a href="https://www.armor.com/armor-complete-secure-hosting/" title="Armor Complete Product Page">Armor Complete</a></strong> (secure public cloud) and <strong><a href="https://www.armor.com/armor-anywhere-security/" title="Armor Anywhere Product Page">Armor Anywhere</a></strong> (security as a service) environments &amp; accounts via a PowerShell module with cmdlets that interact with the published <a href="https://docs.armor.com/display/KBSS/Armor+API+Guide" title="Armor API Guide">RESTful APIs</a>.</p>
<p>Every code push is built on <strong>Windows</strong> via <a href="https://ci.appveyor.com/project/tlindsay42/ArmorPowerShell/branch/master" title="AppVeyor: ArmorPowerShell: Latest Build Console">AppVeyor</a>, as well as on <strong>macOS</strong> and <strong>Ubuntu Linux</strong> via <a href="https://travis-ci.org/tlindsay42/ArmorPowerShell" title="Travis CI: ArmorPowerShell: Latest Build Console">Travis CI</a>, and tested using the <a href="https://github.com/pester/Pester" title="Pester GitHub repo">Pester</a> test &amp; mock framework.</p>
<p>Code coverage scores and reports showing how much of the project is covered by automated tests are tracked by <a href="https://coveralls.io/github/tlindsay42/ArmorPowerShell?branch=master" title="Coveralls: ArmorPowerShell: Latest Report">Coveralls</a>.</p>
<p>Every successful build is published on the <a href="https://www.powershellgallery.com/packages/Armor" title="PowerShell Gallery">PowerShell Gallery</a>.</p>
<p>Please visit the <strong><a href="http://armorpowershell.readthedocs.io/en/latest/?badge=latest" title="ReadTheDocs: ArmorPowerShell: Latest Build">full documentation</a></strong> for more details.</p>
<p>The source code is <a href="https://github.com/tlindsay42/ArmorPowerShell">available on GitHub</a>.</p>
<p>Please visit the <strong><a href="https://tlindsay42.github.io/ArmorPowerShell/" title="GitHubPages: ArmorPowerShell: Latest Build">full documentation</a></strong> for more details.</p>

</div>
</div>
Expand Down Expand Up @@ -343,5 +341,5 @@ <h1 id="armor-powershell-module">Armor PowerShell Module</h1>

<!--
MkDocs version : 0.17.3
Build Date UTC : 2018-06-10 10:11:07
Build Date UTC : 2018-06-10 22:15:22
-->
2 changes: 1 addition & 1 deletion private/Submit-ArmorApiRequest/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -374,7 +374,7 @@ <h3 id="-method">-Method</h3>
</code></pre>

<h3 id="-body">-Body</h3>
<p>Specifies the body of the Armor API request.
<p>Specifies the body of the Armor API request.
Ignored if the request method is
set to Get.</p>
<pre><code class="yaml">Type: String
Expand Down
6 changes: 3 additions & 3 deletions private/Test-ArmorSession/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -310,9 +310,9 @@ <h2 id="syntax">SYNTAX</h2>
</code></pre>

<h2 id="description">DESCRIPTION</h2>
<p>Test to see if a session has been established with the Armor API and that it has not yet expired.
If no token is found, an error will be thrown.
If the session has expired, Disconnect-Armor will be called with confirmation disabled to clean up the session.
<p>Test to see if a session has been established with the Armor API and that it has not yet expired.
If no token is found, an error will be thrown.
If the session has expired, Disconnect-Armor will be called with confirmation disabled to clean up the session.
If less than 2/3 of the session length remain, Update-ArmorApiToken will be called to renew the session.</p>
<p>This cmdlet should be called in the Begin section of public cmdlets for optimal performance, so that the session is not tested repeatedly when pipeline input is processed.</p>
<h2 id="examples">EXAMPLES</h2>
Expand Down
16 changes: 8 additions & 8 deletions public/Connect-Armor/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -311,14 +311,14 @@ <h2 id="syntax">SYNTAX</h2>
</code></pre>

<h2 id="description">DESCRIPTION</h2>
<p>Connects to the Armor RESTful API and supplies credentials to the method.
<p>Connects to the Armor RESTful API and supplies credentials to the method.
The
Armor API then returns a unique, temporary authorization code, which is then
converted into a token to represent the user's credentials for subsequent
calls.
Last, the account context is set.
calls.
Last, the account context is set.
If an account ID is not specified,
one is automatically selected from the list of authorized account IDs.
one is automatically selected from the list of authorized account IDs.
Returns
the session details which are stored in the variable: $Global:ArmorSession.</p>
<h2 id="examples">EXAMPLES</h2>
Expand Down Expand Up @@ -353,7 +353,7 @@ <h3 id="example-5">EXAMPLE 5</h3>
8443/tcp with the credentials stored in the $pscredential object.</p>
<h2 id="parameters">PARAMETERS</h2>
<h3 id="-credential">-Credential</h3>
<p>Your Armor API username and password.
<p>Your Armor API username and password.
If not supplied as a parameter, you will
be prompted for your credentials.</p>
<pre><code class="yaml">Type: PSCredential
Expand All @@ -368,7 +368,7 @@ <h3 id="-credential">-Credential</h3>
</code></pre>

<h3 id="-accountid">-AccountID</h3>
<p>Specifies the Armor account ID to use for all subsequent requests.
<p>Specifies the Armor account ID to use for all subsequent requests.
The
permitted range is 1-65535.</p>
<pre><code class="yaml">Type: UInt16
Expand Down Expand Up @@ -396,7 +396,7 @@ <h3 id="-server">-Server</h3>
</code></pre>

<h3 id="-port">-Port</h3>
<p>Specifies the Armor API server listening TCP port.
<p>Specifies the Armor API server listening TCP port.
The permitted range is:
1-65535.</p>
<pre><code class="yaml">Type: UInt16
Expand All @@ -411,7 +411,7 @@ <h3 id="-port">-Port</h3>
</code></pre>

<h3 id="-apiversion">-ApiVersion</h3>
<p>Specifies the API version for this request.
<p>Specifies the API version for this request.
The specified value is also set as
the default API version for the session as a parameter of the session variable:
'$Global:ArmorSession.ApiVersion'.</p>
Expand Down
4 changes: 2 additions & 2 deletions public/Get-ArmorAccount/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -316,7 +316,7 @@ <h3 id="name">Name</h3>

<h2 id="description">DESCRIPTION</h2>
<p>Retrieves a list of Armor account memberships for the currently authenticated
user.
user.
Returns a set of accounts that correspond to the filter criteria
provided by the cmdlet parameters.</p>
<h2 id="examples">EXAMPLES</h2>
Expand Down Expand Up @@ -406,7 +406,7 @@ <h2 id="notes">NOTES</h2>
<li>GitHub: tlindsay42</li>
</ul>
<h2 id="related-links">RELATED LINKS</h2>
<p><a href="https://tlindsay42.github.io/ArmorPowerShell/public/Get-ArmorAccountAddress/">https://tlindsay42.github.io/ArmorPowerShell/public/Get-ArmorAccountAddress/</a></p>
<p><a href="https://tlindsay42.github.io/ArmorPowerShell/public/Get-ArmorAccount/">https://tlindsay42.github.io/ArmorPowerShell/public/Get-ArmorAccount/</a></p>
<p><a href="https://github.com/tlindsay42/ArmorPowerShell/blob/master/Armor/Public/Get-ArmorAccount.ps1">https://github.com/tlindsay42/ArmorPowerShell/blob/master/Armor/Public/Get-ArmorAccount.ps1</a></p>
<p><a href="https://docs.armor.com/display/KBSS/Get+Accounts">https://docs.armor.com/display/KBSS/Get+Accounts</a></p>
<p><a href="https://developer.armor.com/#!/Account_Management/Accounts_GetAccounts">https://developer.armor.com/#!/Account_Management/Accounts_GetAccounts</a></p>
Expand Down
2 changes: 1 addition & 1 deletion public/Get-ArmorCompleteDatacenter/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -320,7 +320,7 @@ <h3 id="location">Location</h3>

<h2 id="description">DESCRIPTION</h2>
<p>Retrieves details about the Armor Complete datacenters, regions, and compute
zones.
zones.
Returns a set of datacenters that correspond to the filter criteria
provided by the cmdlet parameters.</p>
<h2 id="examples">EXAMPLES</h2>
Expand Down
4 changes: 2 additions & 2 deletions public/Get-ArmorCompleteWorkload/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -323,10 +323,10 @@ <h2 id="description">DESCRIPTION</h2>
servers, such as 'My Secure Website', which could be useful for chargeback or
showback to your customers, as well as helping your staff and the Armor Support
teams understand the architecture of your environment.</p>
<p>Tiers are intended to describe the application tiers within each workload.
<p>Tiers are intended to describe the application tiers within each workload.
A
typical three tiered application workload is comprised of presentation,
business logic, and persistence tiers.
business logic, and persistence tiers.
Common labels for each are: web,
application, and database respectively, but you can group your VMs however you
choose.</p>
Expand Down
4 changes: 2 additions & 2 deletions public/Get-ArmorCompleteWorkloadTier/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -325,10 +325,10 @@ <h2 id="description">DESCRIPTION</h2>
servers, such as 'My Secure Website', which could be useful for chargeback or
showback to your customers, as well as helping your staff and the Armor Support
teams understand the architecture of your environment.</p>
<p>Tiers are intended to describe the application tiers within each workload.
<p>Tiers are intended to describe the application tiers within each workload.
A
typical three tiered application workload is comprised of presentation,
business logic, and persistence tiers.
business logic, and persistence tiers.
Common labels for each are: web,
application, and database respectively, but you can group your VMs however you
choose.</p>
Expand Down
2 changes: 1 addition & 1 deletion public/Get-ArmorUser/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -320,7 +320,7 @@ <h3 id="name">Name</h3>

<h2 id="description">DESCRIPTION</h2>
<p>Retrieves details about the user accounts in the Armor Anywhere or Armor
Complete account in context.
Complete account in context.
Returns a set of user accounts that correspond to
the filter criteria provided by the cmdlet parameters.</p>
<h2 id="examples">EXAMPLES</h2>
Expand Down
4 changes: 2 additions & 2 deletions public/Get-ArmorVM/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -320,7 +320,7 @@ <h3 id="name">Name</h3>

<h2 id="description">DESCRIPTION</h2>
<p>Retrieves details about the virtual machines in the Armor Anywhere or Armor
Complete account in context.
Complete account in context.
Returns a set of virtual machines that correspond
to the filter criteria provided by the cmdlet parameters.</p>
<h2 id="examples">EXAMPLES</h2>
Expand Down Expand Up @@ -440,7 +440,7 @@ <h2 id="notes">NOTES</h2>
</ul>
<h2 id="related-links">RELATED LINKS</h2>
<p><a href="https://tlindsay42.github.io/ArmorPowerShell/public/Get-ArmorVM/">https://tlindsay42.github.io/ArmorPowerShell/public/Get-ArmorVM/</a></p>
<p><a href="https://github.com/tlindsay42/ArmorPowerShell">https://github.com/tlindsay42/ArmorPowerShell</a></p>
<p><a href="https://github.com/tlindsay42/ArmorPowerShell/blob/master/Armor/Public/Get-ArmorVM.ps1">https://github.com/tlindsay42/ArmorPowerShell/blob/master/Armor/Public/Get-ArmorVM.ps1</a></p>
<p><a href="https://docs.armor.com/display/KBSS/Get+VMs">https://docs.armor.com/display/KBSS/Get+VMs</a></p>
<p><a href="https://docs.armor.com/display/KBSS/Get+VM+Detail">https://docs.armor.com/display/KBSS/Get+VM+Detail</a></p>
<p><a href="https://developer.armor.com/#!/Infrastructure/Vm_GetVmList">https://developer.armor.com/#!/Infrastructure/Vm_GetVmList</a></p>
Expand Down
6 changes: 3 additions & 3 deletions public/Invoke-ArmorWebRequest/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -311,7 +311,7 @@ <h2 id="syntax">SYNTAX</h2>
</code></pre>

<h2 id="description">DESCRIPTION</h2>
<p>This cmdlet sends custom HTTPS requests to the Armor API.
<p>This cmdlet sends custom HTTPS requests to the Armor API.
It can be used for
calling API endpoints that are not yet covered by the cmdlets in this module.</p>
<h2 id="examples">EXAMPLES</h2>
Expand Down Expand Up @@ -353,7 +353,7 @@ <h3 id="-headers">-Headers</h3>
</code></pre>

<h3 id="-method">-Method</h3>
<p>Specifies the method used for the Armor API web request.
<p>Specifies the method used for the Armor API web request.
The permitted values
are:
- Delete
Expand All @@ -373,7 +373,7 @@ <h3 id="-method">-Method</h3>
</code></pre>

<h3 id="-body">-Body</h3>
<p>Specifies the body of the Armor API web request.
<p>Specifies the body of the Armor API web request.
This parameter is ignored for
Get requests.</p>
<pre><code class="yaml">Type: String
Expand Down
2 changes: 1 addition & 1 deletion public/Rename-ArmorCompleteVM/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -407,7 +407,7 @@ <h2 id="notes">NOTES</h2>
<li>GitHub: tlindsay42</li>
</ul>
<h2 id="related-links">RELATED LINKS</h2>
<p><a href="https://tlindsay42.github.io/ArmorPowerShell/public/Rename-ArmorCompleteWorkload/">https://tlindsay42.github.io/ArmorPowerShell/public/Rename-ArmorCompleteWorkload/</a></p>
<p><a href="https://tlindsay42.github.io/ArmorPowerShell/public/Rename-ArmorCompleteVM/">https://tlindsay42.github.io/ArmorPowerShell/public/Rename-ArmorCompleteVM/</a></p>
<p><a href="https://github.com/tlindsay42/ArmorPowerShell/blob/master/Armor/Public/Rename-ArmorCompleteVM.ps1">https://github.com/tlindsay42/ArmorPowerShell/blob/master/Armor/Public/Rename-ArmorCompleteVM.ps1</a></p>
<p><a href="https://docs.armor.com/display/KBSS/Update+VM+Name">https://docs.armor.com/display/KBSS/Update+VM+Name</a></p>
<p><a href="https://developer.armor.com/#!/Infrastructure/Vm_UpdateVm">https://developer.armor.com/#!/Infrastructure/Vm_UpdateVm</a></p>
Expand Down
2 changes: 1 addition & 1 deletion public/Rename-ArmorCompleteWorkload/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -407,7 +407,7 @@ <h2 id="notes">NOTES</h2>
<li>GitHub: tlindsay42</li>
</ul>
<h2 id="related-links">RELATED LINKS</h2>
<p><a href="https://tlindsay42.github.io/ArmorPowerShell/public/Rename-ArmorCompleteVM/">https://tlindsay42.github.io/ArmorPowerShell/public/Rename-ArmorCompleteVM/</a></p>
<p><a href="https://tlindsay42.github.io/ArmorPowerShell/public/Rename-ArmorCompleteWorkload/">https://tlindsay42.github.io/ArmorPowerShell/public/Rename-ArmorCompleteWorkload/</a></p>
<p><a href="https://github.com/tlindsay42/ArmorPowerShell/blob/master/Armor/Public/Rename-ArmorCompleteWorkload.ps1">https://github.com/tlindsay42/ArmorPowerShell/blob/master/Armor/Public/Rename-ArmorCompleteWorkload.ps1</a></p>
<p><a href="https://docs.armor.com/display/KBSS/Update+Workload">https://docs.armor.com/display/KBSS/Update+Workload</a></p>
<p><a href="https://developer.armor.com/#!/Infrastructure/App_UpdateApp">https://developer.armor.com/#!/Infrastructure/App_UpdateApp</a></p>
Expand Down
2 changes: 1 addition & 1 deletion public/Reset-ArmorCompleteVM/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -312,7 +312,7 @@ <h2 id="syntax">SYNTAX</h2>
<h2 id="description">DESCRIPTION</h2>
<p>The specified virtual machine in the Armor Complete account in context will be
hard reset- effectively disconnecting the virtual power cord from the VM,
plugging it back in, and then powering it back on.
plugging it back in, and then powering it back on.
This reboot method has the
potential to cause data corruption and should only be used when necessary.</p>
<p>See also: Restart-ArmorCompleteVM</p>
Expand Down
2 changes: 1 addition & 1 deletion public/Restart-ArmorCompleteVM/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -311,7 +311,7 @@ <h2 id="syntax">SYNTAX</h2>

<h2 id="description">DESCRIPTION</h2>
<p>The specified virtual machine will be gracefully rebooted in the Armor Complete
account in context.
account in context.
VMware Tools or open-vm-tools must be installed and
running for this request to succeed.</p>
<p>See also: Reset-ArmorCompleteVM</p>
Expand Down

0 comments on commit 2bc93d7

Please sign in to comment.