AntivirusProductsDetailedStatus

1.0.1.0

en-US/AntivirusProductsDetailedStatus.psm1-Help.xml

                                <?xml version="1.0" encoding="utf-8" ?>

<helpItems xmlns="http://msh" schema="maml">

    <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">

        <command:details>

            <command:name>Get-AntiVirusProduct</command:name>

            <maml:description>

                <maml:para>Antivirus details.</maml:para>

            </maml:description>

            <maml:copyright>

                <maml:para></maml:para>

            </maml:copyright>

            <command:verb>Get</command:verb>

            <command:noun>AntiVirusProduct</command:noun>

            <dev:version/>

        </command:details>

        <maml:description>

                <maml:para>Resolving information about all installed antivirus products.</maml:para>

        </maml:description>

        <command:syntax>

            <command:syntaxItem parametersetname="__AllParameterSets">

                <maml:name>Get-AntiVirusProduct</maml:name>

                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1">

                    <maml:name>List</maml:name>

                    <maml:description>

                        <maml:para>Gives a name list of installed Antivirus products.</maml:para>

                    </maml:description>

                    <command:parameterValue required="false" variableLength="false">switch</command:parameterValue>

                </command:parameter>

                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2">

                    <maml:name>IgnoreDefender</maml:name>

                    <maml:description>

                        <maml:para>Skip checking Windows Defender status.</maml:para>

                    </maml:description>

                    <command:parameterValue required="false" variableLength="false">switch</command:parameterValue>

                </command:parameter>

            </command:syntaxItem>

        </command:syntax>

        <command:parameters>

            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1">

                <maml:name>List</maml:name>

                <maml:description>

                    <maml:para>Gives a name list of installed Antivirus products.</maml:para>

                </maml:description>

                    <command:parameterValue required="false" variableLength="false">switch</command:parameterValue>

                <dev:type>

                    <maml:name>switch</maml:name>

                    <maml:uri/>

                </dev:type>

                <dev:defaultValue></dev:defaultValue>

            </command:parameter>

            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2">

                <maml:name>IgnoreDefender</maml:name>

                <maml:description>

                    <maml:para>Skip checking Windows Defender status.</maml:para>

                </maml:description>

                    <command:parameterValue required="false" variableLength="false">switch</command:parameterValue>

                <dev:type>

                    <maml:name>switch</maml:name>

                    <maml:uri/>

                </dev:type>

                <dev:defaultValue></dev:defaultValue>

            </command:parameter>

        </command:parameters>

        <maml:alertSet>

            <maml:title></maml:title>

            <maml:alert>

                <maml:para>by chixus - CHXOFT (c) 2023.</maml:para>

            </maml:alert>

        </maml:alertSet>

        <command:examples>

            <command:example>

                <maml:title>--------------------------  EXAMPLE 1  --------------------------</maml:title>

                <maml:introduction>

                    <maml:para></maml:para>

                </maml:introduction>

                <dev:code>PS C:\&gt; Get-AntiVirusProduct                     ### Detailed information about installed antivirus product(s).

</dev:code>

                <dev:remarks>

                    <maml:para>PS C:\&gt; Get-AntiVirusProduct -List              ### Name list of Antivirus products installed, use only if there is more than one.

PS C:\&gt; Get-AntiVirusProduct -IgnoreDefender    ### Ignores Windows Defender like it is not present on the system, can be combined with -List switch.</maml:para>

                </dev:remarks>

            </command:example>

        </command:examples>

    </command:command>

    <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">

        <command:details>

            <command:name>Get-AntivirusState</command:name>

            <maml:description>

                <maml:para>Antivirus product state</maml:para>

            </maml:description>

            <maml:copyright>

                <maml:para></maml:para>

            </maml:copyright>

            <command:verb>Get</command:verb>

            <command:noun>AntivirusState</command:noun>

            <dev:version/>

        </command:details>

        <maml:description>

                <maml:para>Returns the third party Antivirus product state details. This command does not get a Windows Defender information.</maml:para>

        </maml:description>

        <command:syntax>

            <command:syntaxItem parametersetname="__AllParameterSets">

                <maml:name>Get-AntivirusState</maml:name>

            </command:syntaxItem>

        </command:syntax>

        <command:parameters>

        </command:parameters>

        <command:returnValues>

            <command:returnValue>

                <dev:type>

<maml:name>System.String</maml:name>

                <maml:uri/>

                </dev:type>

                <maml:description>

                    <maml:para></maml:para>

                </maml:description>

            </command:returnValue>

        </command:returnValues>

        <maml:alertSet>

            <maml:title></maml:title>

            <maml:alert>

                <maml:para>by chixus - CHXOFT (c) 2023.</maml:para>

            </maml:alert>

        </maml:alertSet>

        <command:examples>

            <command:example>

                <maml:title>--------------------------  EXAMPLE 1  --------------------------</maml:title>

                <maml:introduction>

                    <maml:para></maml:para>

                </maml:introduction>

                <dev:code>PS C:\&gt; Get-AntivirusState</dev:code>

                <dev:remarks>

                    <maml:para></maml:para>

                </dev:remarks>

            </command:example>

        </command:examples>

    </command:command>

    <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">

        <command:details>

            <command:name>Get-RealTimeProtection</command:name>

            <maml:description>

                <maml:para>Check Antivirus realtime protection.</maml:para>

            </maml:description>

            <maml:copyright>

                <maml:para></maml:para>

            </maml:copyright>

            <command:verb>Get</command:verb>

            <command:noun>RealTimeProtection</command:noun>

            <dev:version/>

        </command:details>

        <maml:description>

                <maml:para>Returns $true if any Antivirus product Realtime protection status is enabled, $false if there is none.</maml:para>

        </maml:description>

        <command:syntax>

            <command:syntaxItem parametersetname="__AllParameterSets">

                <maml:name>Get-RealTimeProtection</maml:name>

            </command:syntaxItem>

        </command:syntax>

        <command:parameters>

        </command:parameters>

        <command:returnValues>

            <command:returnValue>

                <dev:type>

<maml:name>System.Boolean</maml:name>

                <maml:uri/>

                </dev:type>

                <maml:description>

                    <maml:para></maml:para>

                </maml:description>

            </command:returnValue>

        </command:returnValues>

        <maml:alertSet>

            <maml:title></maml:title>

            <maml:alert>

                <maml:para>by chixus - CHXOFT (c) 2023.</maml:para>

            </maml:alert>

        </maml:alertSet>

        <command:examples>

            <command:example>

                <maml:title>--------------------------  EXAMPLE 1  --------------------------</maml:title>

                <maml:introduction>

                    <maml:para></maml:para>

                </maml:introduction>

                <dev:code>PS C:\&gt; Get-RealTimeProtection        ## Simply returns $true or $false depends of any Antivirus product realtime protection status.</dev:code>

                <dev:remarks>

                    <maml:para></maml:para>

                </dev:remarks>

            </command:example>

        </command:examples>

    </command:command>

    <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">

        <command:details>

            <command:name>Get-WindowsDefender</command:name>

            <maml:description>

                <maml:para>Windows Defender details.</maml:para>

            </maml:description>

            <maml:copyright>

                <maml:para></maml:para>

            </maml:copyright>

            <command:verb>Get</command:verb>

            <command:noun>WindowsDefender</command:noun>

            <dev:version/>

        </command:details>

        <maml:description>

                <maml:para>Get Windows Defender detailed status and activity.</maml:para>

        </maml:description>

        <command:syntax>

            <command:syntaxItem parametersetname="__AllParameterSets">

                <maml:name>Get-WindowsDefender</maml:name>

                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0">

                    <maml:name>Scope</maml:name>

                    <maml:description>

                        <maml:para>Possible Values: AllServer, AllComputer</maml:para>

                    </maml:description>

                    <command:parameterValue required="true" variableLength="false"></command:parameterValue>

                </command:parameter>

            </command:syntaxItem>

        </command:syntax>

        <command:parameters>

            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0">

                <maml:name>Scope</maml:name>

                <maml:description>

                    <maml:para>Possible Values: AllServer, AllComputer</maml:para>

                </maml:description>

                    <command:parameterValue required="true" variableLength="false"></command:parameterValue>

                <dev:type>

                    <maml:name></maml:name>

                    <maml:uri/>

                </dev:type>

                <dev:defaultValue></dev:defaultValue>

            </command:parameter>

        </command:parameters>

        <command:returnValues>

            <command:returnValue>

                <dev:type>

<maml:name>System.Collections.Hashtable</maml:name>

                <maml:uri/>

                </dev:type>

                <maml:description>

                    <maml:para></maml:para>

                </maml:description>

            </command:returnValue>

        </command:returnValues>

        <maml:alertSet>

            <maml:title></maml:title>

            <maml:alert>

                <maml:para>by chixus - CHXOFT (c) 2023.</maml:para>

            </maml:alert>

        </maml:alertSet>

        <command:examples>

            <command:example>

                <maml:title>--------------------------  EXAMPLE 1  --------------------------</maml:title>

                <maml:introduction>

                    <maml:para></maml:para>

                </maml:introduction>

                <dev:code>PS C:\&gt; Get-WindowsDefenderStatus            ### Returns Windows Defenders status details.</dev:code>

                <dev:remarks>

                    <maml:para></maml:para>

                </dev:remarks>

            </command:example>

        </command:examples>

    </command:command>

</helpItems>