Add-PodeEndpoint

NAME Add-PodeEndpoint



SYNOPSIS

Bind an endpoint to listen for incoming Requests.





SYNTAX

Add-PodeEndpoint [-Address <String>] [-Port <Int32>] [-Protocol <String>] -Certificate <String> [-RawCertificate

<X509Certificate>] [-Name <String>] [-RedirectTo <String>] [-Force] [<CommonParameters>]



Add-PodeEndpoint [-Address <String>] [-Port <Int32>] [-Protocol <String>] -CertificateThumbprint <String>

[-RawCertificate <X509Certificate>] [-Name <String>] [-RedirectTo <String>] [-Force] [<CommonParameters>]



Add-PodeEndpoint [-Address <String>] [-Port <Int32>] [-Protocol <String>] -CertificateFile <String>

[-CertificatePassword <String>] [-RawCertificate <X509Certificate>] [-Name <String>] [-RedirectTo <String>]

[-Force] [<CommonParameters>]



Add-PodeEndpoint [-Address <String>] [-Port <Int32>] [-Protocol <String>] -RawCertificate <X509Certificate> [-Name

<String>] [-RedirectTo <String>] [-Force] [<CommonParameters>]



Add-PodeEndpoint [-Address <String>] [-Port <Int32>] [-Protocol <String>] [-RawCertificate <X509Certificate>]

[-Name <String>] [-RedirectTo <String>] [-Force] [-SelfSigned] [<CommonParameters>]





DESCRIPTION

Bind an endpoint to listen for incoming Requests. The endpoints can be HTTP, HTTPS, TCP or SMTP, with the option

to bind certificates.





PARAMETERS

-Address <String>

The IP/Hostname of the endpoint.



Required? false

Position? named

Default value localhost

Accept pipeline input? false

Accept wildcard characters? false



-Port <Int32>

The Port number of the endpoint.



Required? false

Position? named

Default value 0

Accept pipeline input? false

Accept wildcard characters? false



-Protocol <String>

The protocol of the supplied endpoint.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Certificate <String>

A certificate name to find and bind onto HTTPS endpoints (Windows only).



Required? true

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-CertificateThumbprint <String>

A certificate thumbprint to bind onto HTTPS endpoints (Windows only).



Required? true

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-CertificateFile <String>

The path to a certificate that can be use to enable HTTPS (Cross-platform)



Required? true

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-CertificatePassword <String>

The password for the certificate referenced in CertificateFile (Cross-platform)



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-RawCertificate <X509Certificate>

The raw X509 certificate that can be use to enable HTTPS (Cross-platform)



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Name <String>

An optional name for the endpoint, that can be used with other functions.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-RedirectTo <String>

The Name of another Endpoint to automatically generate a redirect route for all traffic.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Force [<SwitchParameter>]

Ignore Adminstrator checks for non-localhost endpoints.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-SelfSigned [<SwitchParameter>]

Create and bind a self-signed certifcate onto HTTPS endpoints (Windows only).



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS



-------------------------- EXAMPLE 1 --------------------------



PS C:\\>Add-PodeEndpoint -Address localhost -Port 8090 -Protocol Http













-------------------------- EXAMPLE 2 --------------------------



PS C:\\>Add-PodeEndpoint -Address localhost -Protocol Smtp













-------------------------- EXAMPLE 3 --------------------------



PS C:\\>Add-PodeEndpoint -Address dev.pode.com -Port 8443 -Protocol Https -SelfSigned













-------------------------- EXAMPLE 4 --------------------------



PS C:\\>Add-PodeEndpoint -Address live.pode.com -Protocol Https -CertificateThumbprint

'2A9467F7D3940243D6C07DE61E7FCCE292'















RELATED LINKS