Get-FluxHivePath

SYNOPSIS

Generated reference for the Get-FluxHivePath Flux PowerShell command.

SYNTAX

Get-FluxHivePath -HiveDirectory <DirectoryInfo> -SdkPath <SdkPath> -EnvironmentName <string> [-TeamName <string>] [<CommonParameters>]

DESCRIPTION

This reference page is generated from the Flux PowerShell module metadata. It documents the command contract while narrative help content is completed.

EXAMPLES

See related use-case and administrator documentation for workflow examples.

PARAMETERS

-EnvironmentName

The Environment Name of the configuration of Flux, typically 'Development' or 'Production'. Please ensure that 'Production' is used for production environments, as it is more secure by default

Type: String
Parameter Sets: (All)
Aliases: None

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-HiveDirectory

The path to the Flux configuration directory location e.g., 'D:\Flux'

Type: DirectoryInfo
Parameter Sets: (All)
Aliases: None

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-SdkPath

The path to the Flux configuration directory location e.g., 'D:\Flux\Sdk\release-1930-x64-gdal-3-10-0-mapserver-8-2-2'

Type: SdkPath
Parameter Sets: (All)
Aliases: None

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-TeamName

The Team Name of the Flux instance that provides authenticated access to Flux for a select group of users that can be configured with varying roles and permissions

Type: String
Parameter Sets: (All)
Aliases: None

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

None

OUTPUTS

Flux.Hive.Infrastructure.Configuration.HivePath

NOTES

Generated from the Flux PowerShell module.

RELATED LINKS