Get D365Environment - FH-Inway/d365fo.tools GitHub Wiki


external help file: d365fo.tools-help.xml Module Name: d365fo.tools online version: schema: 2.0.0

Get-D365Environment

SYNOPSIS

Cmdlet to get the current status for the different services in a Dynamics 365 Finance & Operations environment

SYNTAX

Default (Default)

Get-D365Environment [[-ComputerName] <String[]>] [-All] [-OnlyStartTypeAutomatic] [-OutputServiceDetailsOnly]
 [<CommonParameters>]

Specific

Get-D365Environment [[-ComputerName] <String[]>] [-Aos] [-Batch] [-FinancialReporter] [-DMF]
 [-OnlyStartTypeAutomatic] [-OutputServiceDetailsOnly] [<CommonParameters>]

DESCRIPTION

List status for all relevant services that is running in a D365FO environment

EXAMPLES

EXAMPLE 1

Get-D365Environment

Will query all D365FO service on the machine.

EXAMPLE 2

Get-D365Environment -All

Will query all D365FO service on the machine.

EXAMPLE 3

Get-D365Environment -OnlyStartTypeAutomatic

Will query all D365FO service on the machine. It will filter out all services that are either configured as manual or disabled.

EXAMPLE 4

Get-D365Environment -ComputerName "TEST-SB-AOS1","TEST-SB-AOS2","TEST-SB-BI1" -All

Will query all D365FO service on the different machines.

EXAMPLE 5

Get-D365Environment -Aos -Batch

Will query the Aos & Batch services on the machine.

EXAMPLE 6

Get-D365Environment -FinancialReporter -DMF

Will query the FinancialReporter & DMF services on the machine.

EXAMPLE 7

Get-D365Environment -OutputServiceDetailsOnly

Will query all D365FO service on the machine. Will omit the servername from the output.

EXAMPLE 8

Get-D365Environment -FinancialReporter | Set-Service -StartupType Manual

This will configure the Financial Reporter services to be start type manual.

PARAMETERS

-ComputerName

An array of computers that you want to query for the services status on.

Type: String[]
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: @($env:computername)
Accept pipeline input: False
Accept wildcard characters: False

-All

Set when you want to query all relevant services

Includes: Aos Batch Financial Reporter DMF

Type: SwitchParameter
Parameter Sets: Default
Aliases:

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

-Aos

Instruct the cmdlet to query the AOS (IIS) service

Type: SwitchParameter
Parameter Sets: Specific
Aliases:

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

-Batch

Instruct the cmdlet query the batch service

Type: SwitchParameter
Parameter Sets: Specific
Aliases:

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

-FinancialReporter

Instruct the cmdlet query the financial reporter (Management Reporter 2012)

Type: SwitchParameter
Parameter Sets: Specific
Aliases:

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

-DMF

Instruct the cmdlet query the DMF service

Type: SwitchParameter
Parameter Sets: Specific
Aliases:

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

-OnlyStartTypeAutomatic

Instruct the cmdlet to filter out services that are set to manual start or disabled

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-OutputServiceDetailsOnly

Instruct the cmdlet to exclude the server name from the output

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
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

OUTPUTS

NOTES

Tags: Environment, Service, Services, Aos, Batch, Servicing

Author: Mötz Jensen (@Splaxi)

RELATED LINKS

⚠️ **GitHub.com Fallback** ⚠️