Test-DBPoolApi
-SYNOPSIS
-Checks the availability of the DBPool API using an HTTP HEAD request.
+ + +Converts uri filter parameters
+As of June 2024, DBPool does not support any query parameters. +This is only provided to allow forward compatibility
+ConvertTo-DBPoolQueryString [[-uri_Filter] <Hashtable>] [-resource_Uri] <String> [<CommonParameters>]
+The ConvertTo-DBPoolQueryString cmdlet converts & formats uri filter parameters +from a function which are later used to make the full resource uri for +an API call
This is an internal helper function the ties in directly with the Invoke-DBPoolRequest & any public functions that define parameters
As of June 2024, DBPool does not support any query parameters. This is only provided to allow forward compatibility
ConvertTo-DBPoolQueryString -uri_Filter $uri_Filter -resource_Uri '/api/v2/containers'
+ConvertTo-DBPoolQueryString -uri_Filter $uri_Filter -resource_Uri '/api/v2/containers'
+
+Example: (From public function)
+$uri_Filter = @{}
+
+ForEach ( $Key in $PSBoundParameters.GetEnumerator() ){
+ if( $excludedParameters -contains $Key.Key ){$null}
+ else{ $uri_Filter += @{ $Key.Key = $Key.Value } }
+}
+
+1x key = https://api.DBPool.com/v1/api/v2/containers?parentId=12345
+2x key = https://api.DBPool.com/v1/api/v2/containers?parentId=12345&power=True
-Example: (From public function)
- $uri_Filter = @{}
-ForEach ( $Key in $PSBoundParameters.GetEnumerator() ){
- if( $excludedParameters -contains $Key.Key ){$null}
- else{ $uri_Filter += @{ $Key.Key = $Key.Value } }
-}
-
-1x key = https://api.DBPool.com/v1/api/v2/containers?parentId=12345
-2x key = https://api.DBPool.com/v1/api/v2/containers?parentId=12345&power=True
-
PARAMETERS
-uri_Filter
Hashtable of values to combine a functions parameters with
@@ -1932,7 +2521,7 @@
[System.UriBuilder] - uri_Request
NOTES
N/A
RELATED LINKS
-
+https://datto-dbpool-api.kentsapp.com/Internal/apiCalls/ConvertTo-DBPoolQueryString/
@@ -2017,7 +2606,7 @@ RELATED LINKS
-
+
diff --git a/Internal/apiCalls/Get-DBPoolMetaData/index.html b/Internal/apiCalls/Get-DBPoolMetaData/index.html
index b61eb1d..b50e53f 100644
--- a/Internal/apiCalls/Get-DBPoolMetaData/index.html
+++ b/Internal/apiCalls/Get-DBPoolMetaData/index.html
@@ -20,7 +20,7 @@
-
+
@@ -364,6 +364,24 @@
+
+
+
+
+
+
+
+
+
+
+ en US
+
+
+
+
+
+
+
Gets various API metadata values
Get-DBPoolMetaData [[-base_uri] <String>] [[-resource_uri] <String>] [<CommonParameters>]
+Get-DBPoolMetaData [[-base_uri] <String>] [[-resource_uri] <String>] [<CommonParameters>]
DESCRIPTION
The Get-DBPoolMetaData cmdlet gets various API metadata values from an
@@ -1894,23 +2482,24 @@
DESCRIPTION
as rate-limiting.
EXAMPLES
EXAMPLE 1
-Get-DBPoolMetaData
+Get-DBPoolMetaData
Gets various API metadata values from an Invoke-WebRequest to assist
in various troubleshooting scenarios such as rate-limiting.
The default full base uri test path is:
- https://dbpool.datto.net
+ https://dbpool.datto.net
EXAMPLE 2
-Get-DBPoolMetaData -base_uri http://dbpool.example.com
+Get-DBPoolMetaData -base_uri http://dbpool.example.com
Gets various API metadata values from an Invoke-WebRequest to assist
in various troubleshooting scenarios such as rate-limiting.
The full base uri test path in this example is:
- http://dbpool.example.com/device
+ http://dbpool.example.com/api/v2/self
PARAMETERS
-base_uri
Define the base URI for the DBPool API connection using Datto's DBPool URI or a custom URI.
-The default base URI is https://dbpool.datto.net
+The default base URI is:
+ https://dbpool.datto.net
Type: String
Parameter Sets: (All)
Aliases:
@@ -1943,7 +2532,7 @@ [PSCustomObject] - Various A
NOTES
N/A
RELATED LINKS
-
+https://datto-dbpool-api.kentsapp.com/Internal/apiCalls/Get-DBPoolMetaData/
@@ -2028,7 +2617,7 @@ RELATED LINKS
-
+
diff --git a/Internal/apiCalls/Invoke-DBPoolRequest/index.html b/Internal/apiCalls/Invoke-DBPoolRequest/index.html
index 74f2e79..fad83e1 100644
--- a/Internal/apiCalls/Invoke-DBPoolRequest/index.html
+++ b/Internal/apiCalls/Invoke-DBPoolRequest/index.html
@@ -20,7 +20,7 @@
-
+
@@ -364,6 +364,24 @@
+
+
+
+
+
+
+
+
+
+
+ en US
+
+
+
+
+
+
+
@@ -1706,6 +1724,576 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -1958,31 +2546,33 @@ Invoke-DBPoolRequest
SYNOPSIS
Internal function to make an API request to the DBPool API
SYNTAX
-Invoke-DBPoolRequest [[-method] <String>] [-resource_Uri] <String> [[-uri_Filter] <Hashtable>]
- [[-data] <Hashtable>] [[-DBPool_JSON_Conversion_Depth] <Int32>] [-allPages] [<CommonParameters>]
+Invoke-DBPoolRequest [[-method] <String>] [-resource_Uri] <String> [[-uri_Filter] <Hashtable>]
+ [[-data] <Hashtable>] [[-DBPool_JSON_Conversion_Depth] <Int32>] [-allPages] [<CommonParameters>]
DESCRIPTION
The Invoke-DBPoolRequest cmdlet invokes an API request to DBPool API
This is an internal function that is used by all public functions
EXAMPLES
EXAMPLE 1
-Invoke-DBPoolRequest -method GET -resource_Uri '/api/v2/self' -uri_Filter $uri_Filter
+Invoke-DBPoolRequest -method GET -resource_Uri '/api/v2/self' -uri_Filter $uri_Filter
+
+Name Value
+---- -----
+Method GET
+Uri https://dbpool.datto.net/api/v2/self
+Headers {X-App-Apikey = 3feb2b29-919c-409c-985d-e99cbae43a6d}
+Body
-Name Value
----- -----
-Method GET
-Uri https://dbpool.datto.net/api/v2/self
-Headers {X-App-Apikey = 3feb2b29-919c-409c-985d-e99cbae43a6d}
-Body
Invoke an API request against the defined resource using any of the provided parameters
EXAMPLE 2
-Invoke-DBPoolRequest -method GET -resource_Uri '/api/openapi.json' -uri_Filter $uri_Filter
-Name Value
----- -----
-Method GET
-Uri https://dbpool.datto.net/api/openapi.json
-Headers {X-App-Apikey = 3feb2b29-919c-409c-985d-e99cbae43a6d}
-Body
+Invoke-DBPoolRequest -method GET -resource_Uri '/api/openapi.json' -uri_Filter $uri_Filter
+
+Name Value
+---- -----
+Method GET
+Uri https://dbpool.datto.net/api/openapi.json
+Headers {X-App-Apikey = 3feb2b29-919c-409c-985d-e99cbae43a6d}
+Body
Invoke an API request against the defined resource using any of the provided parameters
PARAMETERS
@@ -2013,7 +2603,7 @@ -resource_Uri
Accept wildcard characters: False
-uri_Filter
-Used with the internal function [ ConvertTo-DBPoolQueryString ] to combine
+
Used with the internal function ConvertTo-DBPoolQueryString to combine
a functions parameters with the resource_Uri parameter.
This allows for the full uri query to occur
The full resource path is made with the following data
@@ -2079,7 +2669,7 @@
NOTES
N/A
RELATED LINKS
-
+https://datto-dbpool-api.kentsapp.com/Internal/apiCalls/Invoke-DBPoolRequest/
@@ -2164,7 +2754,7 @@ RELATED LINKS
-
+
diff --git a/Internal/apiKeys/Add-DBPoolApiKey/index.html b/Internal/apiKeys/Add-DBPoolApiKey/index.html
index fd2048b..4c4faec 100644
--- a/Internal/apiKeys/Add-DBPoolApiKey/index.html
+++ b/Internal/apiKeys/Add-DBPoolApiKey/index.html
@@ -20,7 +20,7 @@
-
+
@@ -364,6 +364,24 @@
+
+
+
+
+
+
+
+
+
+
+ en US
+
+
+
+
+
+
+
@@ -1121,6 +1139,33 @@
+
+
+
+
+
+ -Force
+
+
+
+
+
+
+
+
+ -WhatIf
+
+
+
+
+
+
+
+
+ -Confirm
+
+
+
@@ -1150,7 +1195,7 @@
- [SecureString] - The API key for the DBPool.
+ [SecureString] - The API key for the DBPool
@@ -1174,7 +1219,7 @@
- [void] - No output is returned.
+ [void] - No output is returned
@@ -1661,214 +1706,811 @@
-
-
-
-
- Sets the API key for the DBPool.
Add-DBPoolApiKey [-apiKey] <SecureString> [<CommonParameters>]
+Add-DBPoolApiKey [-apiKey] <SecureString> [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
The Add-DBPoolApiKey cmdlet sets the API key which is used to authenticate API calls made to DBPool.
@@ -1876,12 +2518,12 @@ DESCRIPTION
The DBPool API key is retrieved via the DBPool UI at My Profile -> API key
EXAMPLES
EXAMPLE 1
-Add-DBPoolApiKey
+Add-DBPoolApiKey
Prompts to enter in your personal API key.
EXAMPLE 2
-Add-DBPoolApiKey -ApiKey $secureString
-Read-Host "Enter your DBPool API Key" -AsSecureString | Add-DBPoolApiKey
+Add-DBPoolApiKey -ApiKey $secureString
+Read-Host "Enter your DBPool API Key" -AsSecureString | Add-DBPoolApiKey
Sets the API key for the DBPool.
PARAMETERS
@@ -1897,16 +2539,53 @@ -apiKey
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
+-Force
+Forces the setting of the DBPool API key.
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: False
+Accept pipeline input: False
+Accept wildcard characters: False
+
+-WhatIf
+Shows what would happen if the cmdlet runs.
+The cmdlet is not run.
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases: wi
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+
+-Confirm
+Prompts you for confirmation before running the cmdlet.
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases: cf
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
INPUTS
-[SecureString] - The API key for the DBPool.
+[SecureString] - The API key for the DBPool
OUTPUTS
-[void] - No output is returned.
+[void] - No output is returned
NOTES
N/A
RELATED LINKS
-
+https://datto-dbpool-api.kentsapp.com/Internal/apiKeys/Add-DBPoolApiKey/
@@ -1991,7 +2670,7 @@ RELATED LINKS
-
+
diff --git a/Internal/apiKeys/Get-DBPoolApiKey/index.html b/Internal/apiKeys/Get-DBPoolApiKey/index.html
index cbd6c49..b52a8cc 100644
--- a/Internal/apiKeys/Get-DBPoolApiKey/index.html
+++ b/Internal/apiKeys/Get-DBPoolApiKey/index.html
@@ -20,7 +20,7 @@
-
+
@@ -364,6 +364,24 @@
+
+
+
+
+
+
+
+
+
+
+ en US
+
+
+
+
+
+
+
@@ -1195,7 +1213,7 @@
- [PSCustomObject] - The DBPool API key global variable.
+ [PSCustomObject] - The DBPool API key global variable
@@ -1661,6 +1679,576 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Gets the DBPool API key global variable.
Get-DBPoolApiKey [-AsPlainText] [<CommonParameters>]
+Get-DBPoolApiKey [-AsPlainText] [<CommonParameters>]
DESCRIPTION
The Get-DBPoolApiKey cmdlet gets the DBPool API key global variable and returns this as an object.
EXAMPLES
EXAMPLE 1
-Get-DBPoolApiKey
+Get-DBPoolApiKey
Gets the DBPool API key global variable and returns this as an object with the secret key as a SecureString.
EXAMPLE 2
-Get-DBPoolApiKey -AsPlainText
+Get-DBPoolApiKey -AsPlainText
Gets the DBPool API key global variable and returns this as an object with the secret key as plain text.
PARAMETERS
@@ -1899,11 +2487,11 @@ CommonParameters
INPUTS
N/A
OUTPUTS
-[PSCustomObject] - The DBPool API key global variable.
+[PSCustomObject] - The DBPool API key global variable
NOTES
N\A
RELATED LINKS
-
+https://datto-dbpool-api.kentsapp.com/Internal/apiKeys/Get-DBPoolApiKey/
@@ -1988,7 +2576,7 @@ RELATED LINKS
-
+
diff --git a/Internal/apiKeys/Remove-DBPoolApiKey/index.html b/Internal/apiKeys/Remove-DBPoolApiKey/index.html
index e863960..a6db87b 100644
--- a/Internal/apiKeys/Remove-DBPoolApiKey/index.html
+++ b/Internal/apiKeys/Remove-DBPoolApiKey/index.html
@@ -20,7 +20,7 @@
-
+
@@ -364,6 +364,24 @@
+
+
+
+
+
+
+
+
+
+
+ en US
+
+
+
+
+
+
+
@@ -1225,7 +1243,7 @@
- [void] - No output is returned.
+ [void] - No output is returned
@@ -1670,6 +1688,576 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -1835,7 +2423,7 @@
- [void] - No output is returned.
+ [void] - No output is returned
@@ -1886,13 +2474,13 @@ Remove-DBPoolApiKey
SYNOPSIS
Removes the DBPool API Key global variable.
SYNTAX
-Remove-DBPoolApiKey [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
+Remove-DBPoolApiKey [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
The Remove-DBPoolAPIKey cmdlet removes the DBPool API Key global variable.
EXAMPLES
EXAMPLE 1
-Remove-DBPoolAPIKey
+Remove-DBPoolAPIKey
Removes the DBPool API Key global variable.
PARAMETERS
@@ -1938,11 +2526,11 @@ CommonParameters
INPUTS
N/A
OUTPUTS
-[void] - No output is returned.
+[void] - No output is returned
NOTES
N/A
RELATED LINKS
-
+https://datto-dbpool-api.kentsapp.com/Internal/apiKeys/Remove-DBPoolApiKey/
@@ -2027,7 +2615,7 @@ RELATED LINKS
-
+
diff --git a/Internal/apiKeys/Test-DBPoolApiKey/index.html b/Internal/apiKeys/Test-DBPoolApiKey/index.html
index 310ce1e..d098aec 100644
--- a/Internal/apiKeys/Test-DBPoolApiKey/index.html
+++ b/Internal/apiKeys/Test-DBPoolApiKey/index.html
@@ -20,7 +20,7 @@
-
+
@@ -364,6 +364,24 @@
+
+
+
+
+
+
+
+
+
+
+ en US
+
+
+
+
+
+
+
@@ -1661,6 +1679,576 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -1868,27 +2456,28 @@ Test-DBPoolApiKey
SYNOPSIS
Test the DBPool API Key.
SYNTAX
-Test-DBPoolApiKey [[-base_uri] <String>] [<CommonParameters>]
+Test-DBPoolApiKey [[-base_uri] <String>] [<CommonParameters>]
DESCRIPTION
The Test-DBPoolApiKey cmdlet tests the base URI & API Key that were defined in the Add-DBPoolBaseURI & Add-DBPoolAPIKey cmdlets.
EXAMPLES
EXAMPLE 1
-Test-DBPoolApiKey
+Test-DBPoolApiKey
Tests the base URI & API key that was defined in the Add-DBPoolBaseURI & Add-DBPoolAPIKey cmdlets.
The default full base uri test path is:
- https://dbpool.datto.net/api/v2/self
+ https://dbpool.datto.net/api/v2/self
EXAMPLE 2
-Test-DBPoolApiKey -base_uri http://dbpool.example.com
+Test-DBPoolApiKey -base_uri http://dbpool.example.com
Tests the base URI & API key that was defined in the Add-DBPoolBaseURI & Add-DBPoolAPIKey cmdlets.
The full base uri test path in this example is:
- http://dbpool.example.com/api/v2/self
+ http://dbpool.example.com/api/v2/self
PARAMETERS
-base_uri
Define the base URI for the DBPool API connection using Datto's DBPool URI or a custom URI.
-The default base URI is https://dbpool.datto.net/api
+The default base URI is:
+ https://dbpool.datto.net/api
Type: String
Parameter Sets: (All)
Aliases:
@@ -1908,7 +2497,7 @@ [PSCustomObject] - Various A
NOTES
N/A
RELATED LINKS
-
+https://datto-dbpool-api.kentsapp.com/Internal/apiKeys/Test-DBPoolApiKey/
@@ -1993,7 +2582,7 @@ RELATED LINKS
-
+
diff --git a/Internal/baseUri/Add-DBPoolBaseURI/index.html b/Internal/baseUri/Add-DBPoolBaseURI/index.html
index a8823f0..4bdd664 100644
--- a/Internal/baseUri/Add-DBPoolBaseURI/index.html
+++ b/Internal/baseUri/Add-DBPoolBaseURI/index.html
@@ -20,7 +20,7 @@
-
+
@@ -364,6 +364,24 @@
+
+
+
+
+
+
+
+
+
+
+ en US
+
+
+
+
+
+
+
@@ -1298,7 +1316,7 @@
- [string] - The base URI for the DBPool API connection.
+ [string] - The base URI for the DBPool API connection
@@ -1322,7 +1340,7 @@
- [void] - No output is returned.
+ [void] - No output is returned
@@ -1679,6 +1697,576 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -1829,7 +2417,7 @@
- [string] - The base URI for the DBPool API connection.
+ [string] - The base URI for the DBPool API connection
@@ -1853,7 +2441,7 @@
- [void] - No output is returned.
+ [void] - No output is returned
@@ -1904,24 +2492,24 @@ Add-DBPoolBaseURI
SYNOPSIS
Sets the base URI for the DBPool API connection.
SYNTAX
-Add-DBPoolBaseURI [[-base_uri] <String>] [[-instance] <String>] [<CommonParameters>]
+Add-DBPoolBaseURI [[-base_uri] <String>] [[-instance] <String>] [<CommonParameters>]
DESCRIPTION
The Add-DBPoolBaseURI cmdlet sets the base URI which is later used
to construct the full URI for all API calls.
EXAMPLES
EXAMPLE 1
-Add-DBPoolBaseURI
+Add-DBPoolBaseURI
-The base URI will use https://dbpool.datto.net which is Datto's default DBPool URI.
+The base URI will use https://dbpool.datto.net which is Datto's default DBPool URI.
EXAMPLE 2
-Add-DBPoolBaseURI -instance Datto
+Add-DBPoolBaseURI -instance Datto
-The base URI will use https://dbpool.datto.net which is DBPool's default URI.
+The base URI will use https://dbpool.datto.net which is DBPool's default URI.
EXAMPLE 3
-Add-DBPoolBaseURI -base_uri http://dbpool.example.com
+Add-DBPoolBaseURI -base_uri http://dbpool.example.com
-A custom API gateway of http://dbpool.example.com will be used for all API calls to DBPool's API.
+A custom API gateway of https://dbpool.datto.net will be used for all API calls to DBPool's API.
PARAMETERS
-base_uri
Define the base URI for the DBPool API connection using Datto's DBPool URI or a custom URI.
@@ -1937,9 +2525,11 @@ -base_uri
-instance
DBPool's URI connection point that can be one of the predefined data centers.
-The accepted values for this parameter are:
-[ DEFAULT ]
- DEFAULT = https://dbpool.datto.net
+The accepted values for this parameter are:
+
+- [ DEFAULT ]
+- DEFAULT = https://dbpool.datto.net
+
Placeholder for other data centers.
Type: String
Parameter Sets: (All)
@@ -1954,13 +2544,13 @@ -instance
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
INPUTS
-[string] - The base URI for the DBPool API connection.
+[string] - The base URI for the DBPool API connection
OUTPUTS
-[void] - No output is returned.
+[void] - No output is returned
NOTES
N/A
RELATED LINKS
-
+https://datto-dbpool-api.kentsapp.com/Internal/baseUri/Add-DBPoolBaseURI/
@@ -2045,7 +2635,7 @@ RELATED LINKS
-
+
diff --git a/Internal/baseUri/Get-DBPoolBaseURI/index.html b/Internal/baseUri/Get-DBPoolBaseURI/index.html
index 447fa92..e1493d5 100644
--- a/Internal/baseUri/Get-DBPoolBaseURI/index.html
+++ b/Internal/baseUri/Get-DBPoolBaseURI/index.html
@@ -20,7 +20,7 @@
-
+
@@ -364,6 +364,24 @@
+
+
+
+
+
+
+
+
+
+
+ en US
+
+
+
+
+
+
+
@@ -1307,7 +1325,7 @@
- [void] - No output is returned.
+ [void] - No output is returned
@@ -1643,6 +1661,576 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -1781,7 +2369,7 @@
- [void] - No output is returned.
+ [void] - No output is returned
@@ -1832,13 +2420,13 @@ Get-DBPoolBaseURI
SYNOPSIS
Shows the DBPool base URI global variable.
SYNTAX
-Get-DBPoolBaseURI [<CommonParameters>]
+Get-DBPoolBaseURI [<CommonParameters>]
DESCRIPTION
The Get-DBPoolBaseURI cmdlet shows the DBPool base URI global variable value.
EXAMPLES
EXAMPLE 1
-Get-DBPoolBaseURI
+Get-DBPoolBaseURI
Shows the DBPool base URI global variable value.
PARAMETERS
@@ -1847,11 +2435,11 @@ CommonParameters
INPUTS
N/A
OUTPUTS
-[void] - No output is returned.
+[void] - No output is returned
NOTES
N/A
RELATED LINKS
-
+https://datto-dbpool-api.kentsapp.com/Internal/baseUri/Get-DBPoolBaseURI/
@@ -1936,7 +2524,7 @@ RELATED LINKS
-
+
diff --git a/Internal/baseUri/Remove-DBPoolBaseURI/index.html b/Internal/baseUri/Remove-DBPoolBaseURI/index.html
index a49c681..0fddfd3 100644
--- a/Internal/baseUri/Remove-DBPoolBaseURI/index.html
+++ b/Internal/baseUri/Remove-DBPoolBaseURI/index.html
@@ -20,7 +20,7 @@
-
+
@@ -364,6 +364,24 @@
+
+
+
+
+
+
+
+
+
+
+ en US
+
+
+
+
+
+
+
@@ -1346,7 +1364,7 @@
- [void] - No output is returned.
+ [void] - No output is returned
@@ -1661,6 +1679,576 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -1817,7 +2405,7 @@
- [void] - No output is returned.
+ [void] - No output is returned
@@ -1868,13 +2456,13 @@ Remove-DBPoolBaseURI
SYNOPSIS
Removes the DBPool base URI global variable.
SYNTAX
-Remove-DBPoolBaseURI [-WhatIf] [-Confirm] [<CommonParameters>]
+Remove-DBPoolBaseURI [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
The Remove-DBPoolBaseURI cmdlet removes the DBPool base URI global variable.
EXAMPLES
EXAMPLE 1
-Remove-DBPoolBaseURI
+Remove-DBPoolBaseURI
Removes the DBPool base URI global variable.
PARAMETERS
@@ -1908,11 +2496,11 @@ CommonParameters
INPUTS
N/A
OUTPUTS
-[void] - No output is returned.
+[void] - No output is returned
NOTES
N/A
RELATED LINKS
-
+https://datto-dbpool-api.kentsapp.com/Internal/baseUri/Remove-DBPoolBaseURI/
@@ -1997,7 +2585,7 @@ RELATED LINKS
-
+
diff --git a/Internal/moduleSettings/Export-DBPoolModuleSetting/index.html b/Internal/moduleSettings/Export-DBPoolModuleSetting/index.html
index bacc693..ec0b719 100644
--- a/Internal/moduleSettings/Export-DBPoolModuleSetting/index.html
+++ b/Internal/moduleSettings/Export-DBPoolModuleSetting/index.html
@@ -20,7 +20,7 @@
-
+
@@ -364,6 +364,24 @@
+
+
+
+
+
+
+
+
+
+
+ en US
+
+
+
+
+
+
+
@@ -1422,7 +1440,7 @@
- [void] - No output is returned.
+ [void] - No output is returned
@@ -1670,6 +1688,576 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -1835,7 +2423,7 @@
- [void] - No output is returned.
+ [void] - No output is returned
@@ -1886,7 +2474,7 @@ Export-DBPoolModuleSetting
SYNOPSIS
Exports the DBPool BaseURI, API Key, & JSON configuration information to file.
SYNTAX
-Export-DBPoolModuleSetting [-DBPoolConfPath <String>] [-DBPoolConfFile <String>] [<CommonParameters>]
+Export-DBPoolModuleSetting [-DBPoolConfPath <String>] [-DBPoolConfFile <String>] [<CommonParameters>]
DESCRIPTION
The Export-DBPoolModuleSetting cmdlet exports the DBPool BaseURI, API Key, & JSON configuration information to file.
@@ -1895,13 +2483,13 @@ DESCRIPTION
This means that you cannot copy your configuration file to another computer or user account and expect it to work.
EXAMPLES
EXAMPLE 1
-Export-DBPoolModuleSetting
+Export-DBPoolModuleSetting
Validates that the BaseURI, API Key, and JSON depth are set then exports their values
to the current user's DBPool configuration file located at:
$env:USERPROFILE\DBPoolAPI\config.psd1
EXAMPLE 2
-Export-DBPoolModuleSetting -DBPoolConfPath C:\DBPoolAPI -DBPoolConfFile MyConfig.psd1
+Export-DBPoolModuleSetting -DBPoolConfPath C:\DBPoolAPI -DBPoolConfFile MyConfig.psd1
Validates that the BaseURI, API Key, and JSON depth are set then exports their values
to the current user's DBPool configuration file located at:
@@ -1940,11 +2528,11 @@
CommonParameters
INPUTS
N/A
OUTPUTS
-[void] - No output is returned.
+[void] - No output is returned
NOTES
N/A
RELATED LINKS
-
+https://datto-dbpool-api.kentsapp.com/Internal/moduleSettings/Export-DBPoolModuleSetting/
@@ -2029,7 +2617,7 @@ RELATED LINKS
-
+
diff --git a/Internal/moduleSettings/Get-DBPoolModuleSetting/index.html b/Internal/moduleSettings/Get-DBPoolModuleSetting/index.html
index ac38d72..56ed0ba 100644
--- a/Internal/moduleSettings/Get-DBPoolModuleSetting/index.html
+++ b/Internal/moduleSettings/Get-DBPoolModuleSetting/index.html
@@ -20,7 +20,7 @@
-
+
@@ -364,6 +364,24 @@
+
+
+
+
+
+
+
+
+
+
+ en US
+
+
+
+
+
+
+
@@ -1476,7 +1494,7 @@
- [void] - No output is returned.
+ [void] - No output is returned
@@ -1703,6 +1721,576 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -1901,7 +2489,7 @@
- [void] - No output is returned.
+ [void] - No output is returned
@@ -1953,10 +2541,10 @@ SYNOPSIS
Gets the saved DBPool configuration settings
SYNTAX
index (Default)
-Get-DBPoolModuleSetting [-DBPoolConfPath <String>] [-DBPoolConfFile <String>] [<CommonParameters>]
+Get-DBPoolModuleSetting [-DBPoolConfPath <String>] [-DBPoolConfFile <String>] [<CommonParameters>]
show
-Get-DBPoolModuleSetting [-openConfFile] [<CommonParameters>]
+Get-DBPoolModuleSetting [-openConfFile] [<CommonParameters>]
DESCRIPTION
The Get-DBPoolModuleSetting cmdlet gets the saved DBPool configuration settings
@@ -1965,14 +2553,14 @@
DESCRIPTION
$env:USERPROFILE\DBPoolAPI
EXAMPLES
EXAMPLE 1
-Get-DBPoolModuleSetting
+Get-DBPoolModuleSetting
Gets the contents of the configuration file that was created with the
Export-DBPoolModuleSetting
The default location of the DBPool configuration file is:
$env:USERPROFILE\DBPoolAPI\config.psd1
EXAMPLE 2
-Get-DBPoolModuleSetting -DBPoolConfPath C:\DBPoolAPI -DBPoolConfFile MyConfig.psd1 -openConfFile
+Get-DBPoolModuleSetting -DBPoolConfPath C:\DBPoolAPI -DBPoolConfFile MyConfig.psd1 -openConfFile
Opens the configuration file from the defined location in the default editor
The location of the DBPool configuration file in this example is:
@@ -2023,11 +2611,11 @@
CommonParameters
INPUTS
N/A
OUTPUTS
-[void] - No output is returned.
+[void] - No output is returned
NOTES
N/A
RELATED LINKS
-
+https://datto-dbpool-api.kentsapp.com/Internal/moduleSettings/Get-DBPoolModuleSetting/
@@ -2112,7 +2700,7 @@ RELATED LINKS
-
+
diff --git a/Internal/moduleSettings/Import-DBPoolModuleSetting/index.html b/Internal/moduleSettings/Import-DBPoolModuleSetting/index.html
index b2578b6..7be895c 100644
--- a/Internal/moduleSettings/Import-DBPoolModuleSetting/index.html
+++ b/Internal/moduleSettings/Import-DBPoolModuleSetting/index.html
@@ -20,7 +20,7 @@
-
+
@@ -364,6 +364,24 @@
+
+
+
+
+
+
+
+
+
+
+ en US
+
+
+
+
+
+
+
@@ -1462,9 +1480,9 @@
-
-
+
- N/A
+ [void] - No output is returned
@@ -1670,172 +1688,742 @@
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+