about_bConnectV2.help.txt
|
bConnectV2 PowerShell Module
Import the module To import the module, run the following command: powershell-code: $Path = "Path\To\ModuleFolder" Import-Module "$Path\bConnectV2.psd1" To test if the module was imported, run the following command: powershell-code: Get-Module -Name bConnectV2 If there is a module with the name `bConnectV2` then the import was succesfull Authentication To authenticate with the module, we support the following methods: - Basic authentication with username (type `string`) and password (type `SecureString`) - Authentication with an Apikey (type `SecureString`) It is required to run the `Set-bConnectConfig` at least once or repeat the command(s) if you want to update or change your authentication method The authentication method `Set-bConnectConfig` takes following parameters(powershell-code): -Hostname "YourbConnectFQDN" -Username "YourUsername" -Password $YourPasswordAsSecureString -ApiKey $YourApiKeyAsSecureString With the following parametersets (powershell-code): Set-bConnectConfig -Username "YourUsername" -Password $YourPasswordAsSecureString -Hostname "YourbConnectFQDN" Set-bConnectConfig -ApiKey $YourApiKeyAsSecureString -Hostname "YourbConnectFQDN" powershell-code examples: $YourPasswordAsSecureString = Read-Host -Prompt "Enter your Password" -AsSecureString $YourApiKeyAsSecureString = Read-Host -Prompt "Enter your ApiKey" -AsSecureString # Option Basic authentication Set-bConnectConfig -Password $YourPasswordAsSecureString -Username "YourUsername" -Hostname "bServer.domain.net" # Option apikey authentication Set-bConnectConfig -ApiKey $YourApiKeyAsSecureString -Hostname "bServer.domain.net" # Specified port by appending to hostname Set-bConnectConfig -ApiKey $YourApiKeyAsSecureString -Hostname "bServer.domain.net:8443" Sample scripts Sample scripts are provided in the samples directory of the module. bConnectV2 and powershell module The functions are prefixed with their corresponding bConnectV2 context. See bConnectV2 Documentation. examples given in powershell-code: # ActiveDirectory Context Get-bCActivedirectoryADGroups # Endpoints Context Get-bCEndpointsEndpoints |