ppp

package
v0.0.0-...-3e34f99 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 25, 2023 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Profile

type Profile struct {
	pulumi.CustomResourceState

	// Address list name to which ppp assigned (on server) or received (on client) address will be added.
	AddressList pulumi.StringPtrOutput `pulumi:"addressList"`
	// Name of the bridge interface to which ppp interface will be added as a slave port. Both  tunnel endpoints (server and client) must be in bridge in order to make  this work, see more details on the BCP bridging manual.
	Bridge pulumi.StringPtrOutput `pulumi:"bridge"`
	// Used  split-horizon value for the dynamically created bridge port. Can be  used to prevent bridging loops and isolate traffic. Set the same value  for a group of ports, to prevent them from sending data to ports with  the same horizon value.
	BridgeHorizon pulumi.IntPtrOutput `pulumi:"bridgeHorizon"`
	// Changes MAC learning behavior on the dynamically created bridge port: yes - enables MAC learning no - disables MAC learning default - derive this value from the interface default profile; same as yes if this is the interface default profile.
	BridgeLearning pulumi.StringPtrOutput `pulumi:"bridgeLearning"`
	// Used  path cost for the dynamically created bridge port, used by STP/RSTP to  determine the best path, used by MSTP to determine the best path between  regions. This property has no effect when a bridge protocol-mode is set to none.
	BridgePathCost pulumi.IntPtrOutput `pulumi:"bridgePathCost"`
	// Used  priority for the dynamically created bridge port, used by STP/RSTP to  determine the root port, used by MSTP to determine root port between  regions. This property has no effect when a bridge protocol-mode is set  to none.
	BridgePortPriority pulumi.IntPtrOutput `pulumi:"bridgePortPriority"`
	// Modifies connection MSS settings (applies only for IPv4): yes - adjust connection MSS value no - do not adjust connection MSS value default - derive this value from the interface default profile; same as no if this is the interface default profile.
	ChangeTcpMss pulumi.StringPtrOutput `pulumi:"changeTcpMss"`
	Comment      pulumi.StringPtrOutput `pulumi:"comment"`
	// Default profile sign.
	Default pulumi.StringOutput `pulumi:"default"`
	// Name of the IPv6 pool which will be used by dynamically created DHCPv6-PD server when client connects. [Read more >>](https://wiki.mikrotik.com/wiki/Manual:IPv6_PD_over_PPP)
	Dhcpv6PdPool pulumi.StringPtrOutput `pulumi:"dhcpv6PdPool"`
	// IP address of the DNS server that is supplied to ppp clients.
	DnsServers pulumi.StringArrayOutput `pulumi:"dnsServers"`
	// Specifies  the amount of time after which the link will be terminated if there are  no activity present. Timeout is not set by default.
	IdleTimeout pulumi.StringPtrOutput `pulumi:"idleTimeout"`
	// Firewall  chain name for incoming packets. Specified chain gets control for each  packet coming from the client. The ppp chain should be manually added  and rules with action=jump jump-target=ppp should be added to other  relevant chains in order for this feature to work. For more information  look at the examples section.
	IncomingFilter pulumi.StringPtrOutput `pulumi:"incomingFilter"`
	// Specify where to place dynamic simple queue entries for static DCHP leases with rate-limit parameter set.
	InsertQueueBefore pulumi.StringPtrOutput `pulumi:"insertQueueBefore"`
	// Interface list name.
	InterfaceList pulumi.StringPtrOutput `pulumi:"interfaceList"`
	// Tunnel address or name of the pool from which address is assigned to ppp interface locally.
	LocalAddress pulumi.StringPtrOutput `pulumi:"localAddress"`
	// PPP profile name.
	Name pulumi.StringOutput `pulumi:"name"`
	// Execute script on user logging off. See on-up for more details.
	OnDown pulumi.StringPtrOutput `pulumi:"onDown"`
	// Execute script on user login-event. These are available variables that are accessible for the event script: *user *local-address *remote-address *caller-id *called-id *interface.
	OnUp pulumi.StringPtrOutput `pulumi:"onUp"`
	// Defines whether a user is allowed to have more than one ppp session at a time yes - a user is not allowed to have more than one ppp session at a time no - the user is allowed to have more than one ppp session at a time default - derive this value from the interface default profile; same as no if this is the interface default profile.
	OnlyOne pulumi.StringPtrOutput `pulumi:"onlyOne"`
	// Firewall  chain name for outgoing packets. The specified chain gets control for  each packet going to the client. The PPP chain should be manually added  and rules with action=jump jump-target=ppp should be added to other  relevant chains in order for this feature to work. For more information  look at the Examples section.
	OutgoingFilter pulumi.StringPtrOutput `pulumi:"outgoingFilter"`
	// Name of parent simple queue.
	ParentQueue pulumi.StringPtrOutput `pulumi:"parentQueue"`
	// Queue types.
	QueueType pulumi.StringPtrOutput `pulumi:"queueType"`
	// Rate limitation in form of rx-rate[/tx-rate]  [rx-burst-rate[/tx-burst-rate] [rx-burst-threshold[/tx-burst-threshold]  [rx-burst-time[/tx-burst-time] [priority] [rx-rate-min[/tx-rate-min]]]] from the point of view of the router (so 'rx' is client upload, and  'tx' is client download). All rates are measured in bits per second,  unless followed by optional 'k' suffix (kilobits per second) or 'M'  suffix (megabits per second). If tx-rate is not specified, rx-rate  serves as tx-rate too. The same applies for tx-burst-rate,  tx-burst-threshold and tx-burst-time. If both rx-burst-threshold and  tx-burst-threshold are not specified (but burst-rate is specified),  rx-rate and tx-rate are used as burst thresholds. If both rx-burst-time  and tx-burst-time are not specified, 1s is used as default. Priority  takes values 1..8, where 1 implies the highest priority, but 8 - the  lowest. If rx-rate-min and tx-rate-min are not specified rx-rate and  tx-rate values are used. The rx-rate-min and tx-rate-min values can not  exceed rx-rate and tx-rate values.
	RateLimit pulumi.StringPtrOutput `pulumi:"rateLimit"`
	// Tunnel address or name of the pool from which address is assigned to remote ppp interface.
	RemoteAddress pulumi.StringPtrOutput `pulumi:"remoteAddress"`
	// Assign prefix from IPv6 pool to the client and install corresponding IPv6 route.
	RemoteIpv6PrefixPool pulumi.StringPtrOutput `pulumi:"remoteIpv6PrefixPool"`
	// Maximum time the connection can stay up. By default no time limit is set.
	SessionTimeout pulumi.StringPtrOutput `pulumi:"sessionTimeout"`
	// Specifies whether to use data compression or not. yes - enable data compression no - disable data compression default - derive this value from the interface default profile; same as no if this is the interface default profile This setting does not affect OVPN tunnels.
	UseCompression pulumi.StringPtrOutput `pulumi:"useCompression"`
	// Specifies whether to use data encryption or not. yes - enable data encryption no - disable data encryption default - derive this value from the interface default profile; same as no if this is the interface default profile require - explicitly requires encryption This setting does not work on OVPN and SSTP tunnels.
	UseEncryption pulumi.StringPtrOutput `pulumi:"useEncryption"`
	// Specifies whether to allow IPv6. By default is enabled if IPv6 package is installed. yes - enable IPv6 support no - disable IPv6 support default - derive this value from the interface default profile; same as no if this is the interface default profile require - explicitly requires IPv6 support.
	UseIpv6 pulumi.StringPtrOutput `pulumi:"useIpv6"`
	// Specifies whether to allow MPLS over PPP. yes - enable MPLS support no - disable MPLS support default - derive this value from the interface default profile; same as no if this is the interface default profile require - explicitly requires MPLS support
	UseMpls pulumi.StringPtrOutput `pulumi:"useMpls"`
	// Specifies whether to allow UPnP.
	UseUpnp pulumi.StringPtrOutput `pulumi:"useUpnp"`
	// IP address of the WINS server to supply to Windows clients.
	WinsServers pulumi.StringArrayOutput `pulumi:"winsServers"`
	// contains filtered or unexported fields
}

## Example Usage

```go package main

import (

"github.com/pulumi/pulumi-routeros/sdk/go/routeros/Ppp"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := Ppp.NewProfile(ctx, "test", &Ppp.ProfileArgs{
			LocalAddress:  pulumi.String("192.168.77.1"),
			RemoteAddress: pulumi.String("ovpn-pool"),
			UseUpnp:       pulumi.String("no"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

#The ID can be found via API or the terminal #The command for the terminal is -> :put [/ppp/profile get [print show-ids]]

```sh

$ pulumi import routeros:Ppp/profile:Profile test *6

```

func GetProfile

func GetProfile(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ProfileState, opts ...pulumi.ResourceOption) (*Profile, error)

GetProfile gets an existing Profile resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewProfile

func NewProfile(ctx *pulumi.Context,
	name string, args *ProfileArgs, opts ...pulumi.ResourceOption) (*Profile, error)

NewProfile registers a new resource with the given unique name, arguments, and options.

func (*Profile) ElementType

func (*Profile) ElementType() reflect.Type

func (*Profile) ToProfileOutput

func (i *Profile) ToProfileOutput() ProfileOutput

func (*Profile) ToProfileOutputWithContext

func (i *Profile) ToProfileOutputWithContext(ctx context.Context) ProfileOutput

type ProfileArgs

type ProfileArgs struct {

	// Address list name to which ppp assigned (on server) or received (on client) address will be added.
	AddressList pulumi.StringPtrInput
	// Name of the bridge interface to which ppp interface will be added as a slave port. Both  tunnel endpoints (server and client) must be in bridge in order to make  this work, see more details on the BCP bridging manual.
	Bridge pulumi.StringPtrInput
	// Used  split-horizon value for the dynamically created bridge port. Can be  used to prevent bridging loops and isolate traffic. Set the same value  for a group of ports, to prevent them from sending data to ports with  the same horizon value.
	BridgeHorizon pulumi.IntPtrInput
	// Changes MAC learning behavior on the dynamically created bridge port: yes - enables MAC learning no - disables MAC learning default - derive this value from the interface default profile; same as yes if this is the interface default profile.
	BridgeLearning pulumi.StringPtrInput
	// Used  path cost for the dynamically created bridge port, used by STP/RSTP to  determine the best path, used by MSTP to determine the best path between  regions. This property has no effect when a bridge protocol-mode is set to none.
	BridgePathCost pulumi.IntPtrInput
	// Used  priority for the dynamically created bridge port, used by STP/RSTP to  determine the root port, used by MSTP to determine root port between  regions. This property has no effect when a bridge protocol-mode is set  to none.
	BridgePortPriority pulumi.IntPtrInput
	// Modifies connection MSS settings (applies only for IPv4): yes - adjust connection MSS value no - do not adjust connection MSS value default - derive this value from the interface default profile; same as no if this is the interface default profile.
	ChangeTcpMss pulumi.StringPtrInput
	Comment      pulumi.StringPtrInput
	// Name of the IPv6 pool which will be used by dynamically created DHCPv6-PD server when client connects. [Read more >>](https://wiki.mikrotik.com/wiki/Manual:IPv6_PD_over_PPP)
	Dhcpv6PdPool pulumi.StringPtrInput
	// IP address of the DNS server that is supplied to ppp clients.
	DnsServers pulumi.StringArrayInput
	// Specifies  the amount of time after which the link will be terminated if there are  no activity present. Timeout is not set by default.
	IdleTimeout pulumi.StringPtrInput
	// Firewall  chain name for incoming packets. Specified chain gets control for each  packet coming from the client. The ppp chain should be manually added  and rules with action=jump jump-target=ppp should be added to other  relevant chains in order for this feature to work. For more information  look at the examples section.
	IncomingFilter pulumi.StringPtrInput
	// Specify where to place dynamic simple queue entries for static DCHP leases with rate-limit parameter set.
	InsertQueueBefore pulumi.StringPtrInput
	// Interface list name.
	InterfaceList pulumi.StringPtrInput
	// Tunnel address or name of the pool from which address is assigned to ppp interface locally.
	LocalAddress pulumi.StringPtrInput
	// PPP profile name.
	Name pulumi.StringPtrInput
	// Execute script on user logging off. See on-up for more details.
	OnDown pulumi.StringPtrInput
	// Execute script on user login-event. These are available variables that are accessible for the event script: *user *local-address *remote-address *caller-id *called-id *interface.
	OnUp pulumi.StringPtrInput
	// Defines whether a user is allowed to have more than one ppp session at a time yes - a user is not allowed to have more than one ppp session at a time no - the user is allowed to have more than one ppp session at a time default - derive this value from the interface default profile; same as no if this is the interface default profile.
	OnlyOne pulumi.StringPtrInput
	// Firewall  chain name for outgoing packets. The specified chain gets control for  each packet going to the client. The PPP chain should be manually added  and rules with action=jump jump-target=ppp should be added to other  relevant chains in order for this feature to work. For more information  look at the Examples section.
	OutgoingFilter pulumi.StringPtrInput
	// Name of parent simple queue.
	ParentQueue pulumi.StringPtrInput
	// Queue types.
	QueueType pulumi.StringPtrInput
	// Rate limitation in form of rx-rate[/tx-rate]  [rx-burst-rate[/tx-burst-rate] [rx-burst-threshold[/tx-burst-threshold]  [rx-burst-time[/tx-burst-time] [priority] [rx-rate-min[/tx-rate-min]]]] from the point of view of the router (so 'rx' is client upload, and  'tx' is client download). All rates are measured in bits per second,  unless followed by optional 'k' suffix (kilobits per second) or 'M'  suffix (megabits per second). If tx-rate is not specified, rx-rate  serves as tx-rate too. The same applies for tx-burst-rate,  tx-burst-threshold and tx-burst-time. If both rx-burst-threshold and  tx-burst-threshold are not specified (but burst-rate is specified),  rx-rate and tx-rate are used as burst thresholds. If both rx-burst-time  and tx-burst-time are not specified, 1s is used as default. Priority  takes values 1..8, where 1 implies the highest priority, but 8 - the  lowest. If rx-rate-min and tx-rate-min are not specified rx-rate and  tx-rate values are used. The rx-rate-min and tx-rate-min values can not  exceed rx-rate and tx-rate values.
	RateLimit pulumi.StringPtrInput
	// Tunnel address or name of the pool from which address is assigned to remote ppp interface.
	RemoteAddress pulumi.StringPtrInput
	// Assign prefix from IPv6 pool to the client and install corresponding IPv6 route.
	RemoteIpv6PrefixPool pulumi.StringPtrInput
	// Maximum time the connection can stay up. By default no time limit is set.
	SessionTimeout pulumi.StringPtrInput
	// Specifies whether to use data compression or not. yes - enable data compression no - disable data compression default - derive this value from the interface default profile; same as no if this is the interface default profile This setting does not affect OVPN tunnels.
	UseCompression pulumi.StringPtrInput
	// Specifies whether to use data encryption or not. yes - enable data encryption no - disable data encryption default - derive this value from the interface default profile; same as no if this is the interface default profile require - explicitly requires encryption This setting does not work on OVPN and SSTP tunnels.
	UseEncryption pulumi.StringPtrInput
	// Specifies whether to allow IPv6. By default is enabled if IPv6 package is installed. yes - enable IPv6 support no - disable IPv6 support default - derive this value from the interface default profile; same as no if this is the interface default profile require - explicitly requires IPv6 support.
	UseIpv6 pulumi.StringPtrInput
	// Specifies whether to allow MPLS over PPP. yes - enable MPLS support no - disable MPLS support default - derive this value from the interface default profile; same as no if this is the interface default profile require - explicitly requires MPLS support
	UseMpls pulumi.StringPtrInput
	// Specifies whether to allow UPnP.
	UseUpnp pulumi.StringPtrInput
	// IP address of the WINS server to supply to Windows clients.
	WinsServers pulumi.StringArrayInput
	// contains filtered or unexported fields
}

The set of arguments for constructing a Profile resource.

func (ProfileArgs) ElementType

func (ProfileArgs) ElementType() reflect.Type

type ProfileArray

type ProfileArray []ProfileInput

func (ProfileArray) ElementType

func (ProfileArray) ElementType() reflect.Type

func (ProfileArray) ToProfileArrayOutput

func (i ProfileArray) ToProfileArrayOutput() ProfileArrayOutput

func (ProfileArray) ToProfileArrayOutputWithContext

func (i ProfileArray) ToProfileArrayOutputWithContext(ctx context.Context) ProfileArrayOutput

type ProfileArrayInput

type ProfileArrayInput interface {
	pulumi.Input

	ToProfileArrayOutput() ProfileArrayOutput
	ToProfileArrayOutputWithContext(context.Context) ProfileArrayOutput
}

ProfileArrayInput is an input type that accepts ProfileArray and ProfileArrayOutput values. You can construct a concrete instance of `ProfileArrayInput` via:

ProfileArray{ ProfileArgs{...} }

type ProfileArrayOutput

type ProfileArrayOutput struct{ *pulumi.OutputState }

func (ProfileArrayOutput) ElementType

func (ProfileArrayOutput) ElementType() reflect.Type

func (ProfileArrayOutput) Index

func (ProfileArrayOutput) ToProfileArrayOutput

func (o ProfileArrayOutput) ToProfileArrayOutput() ProfileArrayOutput

func (ProfileArrayOutput) ToProfileArrayOutputWithContext

func (o ProfileArrayOutput) ToProfileArrayOutputWithContext(ctx context.Context) ProfileArrayOutput

type ProfileInput

type ProfileInput interface {
	pulumi.Input

	ToProfileOutput() ProfileOutput
	ToProfileOutputWithContext(ctx context.Context) ProfileOutput
}

type ProfileMap

type ProfileMap map[string]ProfileInput

func (ProfileMap) ElementType

func (ProfileMap) ElementType() reflect.Type

func (ProfileMap) ToProfileMapOutput

func (i ProfileMap) ToProfileMapOutput() ProfileMapOutput

func (ProfileMap) ToProfileMapOutputWithContext

func (i ProfileMap) ToProfileMapOutputWithContext(ctx context.Context) ProfileMapOutput

type ProfileMapInput

type ProfileMapInput interface {
	pulumi.Input

	ToProfileMapOutput() ProfileMapOutput
	ToProfileMapOutputWithContext(context.Context) ProfileMapOutput
}

ProfileMapInput is an input type that accepts ProfileMap and ProfileMapOutput values. You can construct a concrete instance of `ProfileMapInput` via:

ProfileMap{ "key": ProfileArgs{...} }

type ProfileMapOutput

type ProfileMapOutput struct{ *pulumi.OutputState }

func (ProfileMapOutput) ElementType

func (ProfileMapOutput) ElementType() reflect.Type

func (ProfileMapOutput) MapIndex

func (ProfileMapOutput) ToProfileMapOutput

func (o ProfileMapOutput) ToProfileMapOutput() ProfileMapOutput

func (ProfileMapOutput) ToProfileMapOutputWithContext

func (o ProfileMapOutput) ToProfileMapOutputWithContext(ctx context.Context) ProfileMapOutput

type ProfileOutput

type ProfileOutput struct{ *pulumi.OutputState }

func (ProfileOutput) AddressList

func (o ProfileOutput) AddressList() pulumi.StringPtrOutput

Address list name to which ppp assigned (on server) or received (on client) address will be added.

func (ProfileOutput) Bridge

Name of the bridge interface to which ppp interface will be added as a slave port. Both tunnel endpoints (server and client) must be in bridge in order to make this work, see more details on the BCP bridging manual.

func (ProfileOutput) BridgeHorizon

func (o ProfileOutput) BridgeHorizon() pulumi.IntPtrOutput

Used split-horizon value for the dynamically created bridge port. Can be used to prevent bridging loops and isolate traffic. Set the same value for a group of ports, to prevent them from sending data to ports with the same horizon value.

func (ProfileOutput) BridgeLearning

func (o ProfileOutput) BridgeLearning() pulumi.StringPtrOutput

Changes MAC learning behavior on the dynamically created bridge port: yes - enables MAC learning no - disables MAC learning default - derive this value from the interface default profile; same as yes if this is the interface default profile.

func (ProfileOutput) BridgePathCost

func (o ProfileOutput) BridgePathCost() pulumi.IntPtrOutput

Used path cost for the dynamically created bridge port, used by STP/RSTP to determine the best path, used by MSTP to determine the best path between regions. This property has no effect when a bridge protocol-mode is set to none.

func (ProfileOutput) BridgePortPriority

func (o ProfileOutput) BridgePortPriority() pulumi.IntPtrOutput

Used priority for the dynamically created bridge port, used by STP/RSTP to determine the root port, used by MSTP to determine root port between regions. This property has no effect when a bridge protocol-mode is set to none.

func (ProfileOutput) ChangeTcpMss

func (o ProfileOutput) ChangeTcpMss() pulumi.StringPtrOutput

Modifies connection MSS settings (applies only for IPv4): yes - adjust connection MSS value no - do not adjust connection MSS value default - derive this value from the interface default profile; same as no if this is the interface default profile.

func (ProfileOutput) Comment

func (o ProfileOutput) Comment() pulumi.StringPtrOutput

func (ProfileOutput) Default

func (o ProfileOutput) Default() pulumi.StringOutput

Default profile sign.

func (ProfileOutput) Dhcpv6PdPool

func (o ProfileOutput) Dhcpv6PdPool() pulumi.StringPtrOutput

Name of the IPv6 pool which will be used by dynamically created DHCPv6-PD server when client connects. [Read more >>](https://wiki.mikrotik.com/wiki/Manual:IPv6_PD_over_PPP)

func (ProfileOutput) DnsServers

func (o ProfileOutput) DnsServers() pulumi.StringArrayOutput

IP address of the DNS server that is supplied to ppp clients.

func (ProfileOutput) ElementType

func (ProfileOutput) ElementType() reflect.Type

func (ProfileOutput) IdleTimeout

func (o ProfileOutput) IdleTimeout() pulumi.StringPtrOutput

Specifies the amount of time after which the link will be terminated if there are no activity present. Timeout is not set by default.

func (ProfileOutput) IncomingFilter

func (o ProfileOutput) IncomingFilter() pulumi.StringPtrOutput

Firewall chain name for incoming packets. Specified chain gets control for each packet coming from the client. The ppp chain should be manually added and rules with action=jump jump-target=ppp should be added to other relevant chains in order for this feature to work. For more information look at the examples section.

func (ProfileOutput) InsertQueueBefore

func (o ProfileOutput) InsertQueueBefore() pulumi.StringPtrOutput

Specify where to place dynamic simple queue entries for static DCHP leases with rate-limit parameter set.

func (ProfileOutput) InterfaceList

func (o ProfileOutput) InterfaceList() pulumi.StringPtrOutput

Interface list name.

func (ProfileOutput) LocalAddress

func (o ProfileOutput) LocalAddress() pulumi.StringPtrOutput

Tunnel address or name of the pool from which address is assigned to ppp interface locally.

func (ProfileOutput) Name

PPP profile name.

func (ProfileOutput) OnDown

Execute script on user logging off. See on-up for more details.

func (ProfileOutput) OnUp

Execute script on user login-event. These are available variables that are accessible for the event script: *user *local-address *remote-address *caller-id *called-id *interface.

func (ProfileOutput) OnlyOne

func (o ProfileOutput) OnlyOne() pulumi.StringPtrOutput

Defines whether a user is allowed to have more than one ppp session at a time yes - a user is not allowed to have more than one ppp session at a time no - the user is allowed to have more than one ppp session at a time default - derive this value from the interface default profile; same as no if this is the interface default profile.

func (ProfileOutput) OutgoingFilter

func (o ProfileOutput) OutgoingFilter() pulumi.StringPtrOutput

Firewall chain name for outgoing packets. The specified chain gets control for each packet going to the client. The PPP chain should be manually added and rules with action=jump jump-target=ppp should be added to other relevant chains in order for this feature to work. For more information look at the Examples section.

func (ProfileOutput) ParentQueue

func (o ProfileOutput) ParentQueue() pulumi.StringPtrOutput

Name of parent simple queue.

func (ProfileOutput) QueueType

func (o ProfileOutput) QueueType() pulumi.StringPtrOutput

Queue types.

func (ProfileOutput) RateLimit

func (o ProfileOutput) RateLimit() pulumi.StringPtrOutput

Rate limitation in form of rx-rate[/tx-rate] [rx-burst-rate[/tx-burst-rate] [rx-burst-threshold[/tx-burst-threshold] [rx-burst-time[/tx-burst-time] [priority] [rx-rate-min[/tx-rate-min]]]] from the point of view of the router (so 'rx' is client upload, and 'tx' is client download). All rates are measured in bits per second, unless followed by optional 'k' suffix (kilobits per second) or 'M' suffix (megabits per second). If tx-rate is not specified, rx-rate serves as tx-rate too. The same applies for tx-burst-rate, tx-burst-threshold and tx-burst-time. If both rx-burst-threshold and tx-burst-threshold are not specified (but burst-rate is specified), rx-rate and tx-rate are used as burst thresholds. If both rx-burst-time and tx-burst-time are not specified, 1s is used as default. Priority takes values 1..8, where 1 implies the highest priority, but 8 - the lowest. If rx-rate-min and tx-rate-min are not specified rx-rate and tx-rate values are used. The rx-rate-min and tx-rate-min values can not exceed rx-rate and tx-rate values.

func (ProfileOutput) RemoteAddress

func (o ProfileOutput) RemoteAddress() pulumi.StringPtrOutput

Tunnel address or name of the pool from which address is assigned to remote ppp interface.

func (ProfileOutput) RemoteIpv6PrefixPool

func (o ProfileOutput) RemoteIpv6PrefixPool() pulumi.StringPtrOutput

Assign prefix from IPv6 pool to the client and install corresponding IPv6 route.

func (ProfileOutput) SessionTimeout

func (o ProfileOutput) SessionTimeout() pulumi.StringPtrOutput

Maximum time the connection can stay up. By default no time limit is set.

func (ProfileOutput) ToProfileOutput

func (o ProfileOutput) ToProfileOutput() ProfileOutput

func (ProfileOutput) ToProfileOutputWithContext

func (o ProfileOutput) ToProfileOutputWithContext(ctx context.Context) ProfileOutput

func (ProfileOutput) UseCompression

func (o ProfileOutput) UseCompression() pulumi.StringPtrOutput

Specifies whether to use data compression or not. yes - enable data compression no - disable data compression default - derive this value from the interface default profile; same as no if this is the interface default profile This setting does not affect OVPN tunnels.

func (ProfileOutput) UseEncryption

func (o ProfileOutput) UseEncryption() pulumi.StringPtrOutput

Specifies whether to use data encryption or not. yes - enable data encryption no - disable data encryption default - derive this value from the interface default profile; same as no if this is the interface default profile require - explicitly requires encryption This setting does not work on OVPN and SSTP tunnels.

func (ProfileOutput) UseIpv6

func (o ProfileOutput) UseIpv6() pulumi.StringPtrOutput

Specifies whether to allow IPv6. By default is enabled if IPv6 package is installed. yes - enable IPv6 support no - disable IPv6 support default - derive this value from the interface default profile; same as no if this is the interface default profile require - explicitly requires IPv6 support.

func (ProfileOutput) UseMpls

func (o ProfileOutput) UseMpls() pulumi.StringPtrOutput

Specifies whether to allow MPLS over PPP. yes - enable MPLS support no - disable MPLS support default - derive this value from the interface default profile; same as no if this is the interface default profile require - explicitly requires MPLS support

func (ProfileOutput) UseUpnp

func (o ProfileOutput) UseUpnp() pulumi.StringPtrOutput

Specifies whether to allow UPnP.

func (ProfileOutput) WinsServers

func (o ProfileOutput) WinsServers() pulumi.StringArrayOutput

IP address of the WINS server to supply to Windows clients.

type ProfileState

type ProfileState struct {

	// Address list name to which ppp assigned (on server) or received (on client) address will be added.
	AddressList pulumi.StringPtrInput
	// Name of the bridge interface to which ppp interface will be added as a slave port. Both  tunnel endpoints (server and client) must be in bridge in order to make  this work, see more details on the BCP bridging manual.
	Bridge pulumi.StringPtrInput
	// Used  split-horizon value for the dynamically created bridge port. Can be  used to prevent bridging loops and isolate traffic. Set the same value  for a group of ports, to prevent them from sending data to ports with  the same horizon value.
	BridgeHorizon pulumi.IntPtrInput
	// Changes MAC learning behavior on the dynamically created bridge port: yes - enables MAC learning no - disables MAC learning default - derive this value from the interface default profile; same as yes if this is the interface default profile.
	BridgeLearning pulumi.StringPtrInput
	// Used  path cost for the dynamically created bridge port, used by STP/RSTP to  determine the best path, used by MSTP to determine the best path between  regions. This property has no effect when a bridge protocol-mode is set to none.
	BridgePathCost pulumi.IntPtrInput
	// Used  priority for the dynamically created bridge port, used by STP/RSTP to  determine the root port, used by MSTP to determine root port between  regions. This property has no effect when a bridge protocol-mode is set  to none.
	BridgePortPriority pulumi.IntPtrInput
	// Modifies connection MSS settings (applies only for IPv4): yes - adjust connection MSS value no - do not adjust connection MSS value default - derive this value from the interface default profile; same as no if this is the interface default profile.
	ChangeTcpMss pulumi.StringPtrInput
	Comment      pulumi.StringPtrInput
	// Default profile sign.
	Default pulumi.StringPtrInput
	// Name of the IPv6 pool which will be used by dynamically created DHCPv6-PD server when client connects. [Read more >>](https://wiki.mikrotik.com/wiki/Manual:IPv6_PD_over_PPP)
	Dhcpv6PdPool pulumi.StringPtrInput
	// IP address of the DNS server that is supplied to ppp clients.
	DnsServers pulumi.StringArrayInput
	// Specifies  the amount of time after which the link will be terminated if there are  no activity present. Timeout is not set by default.
	IdleTimeout pulumi.StringPtrInput
	// Firewall  chain name for incoming packets. Specified chain gets control for each  packet coming from the client. The ppp chain should be manually added  and rules with action=jump jump-target=ppp should be added to other  relevant chains in order for this feature to work. For more information  look at the examples section.
	IncomingFilter pulumi.StringPtrInput
	// Specify where to place dynamic simple queue entries for static DCHP leases with rate-limit parameter set.
	InsertQueueBefore pulumi.StringPtrInput
	// Interface list name.
	InterfaceList pulumi.StringPtrInput
	// Tunnel address or name of the pool from which address is assigned to ppp interface locally.
	LocalAddress pulumi.StringPtrInput
	// PPP profile name.
	Name pulumi.StringPtrInput
	// Execute script on user logging off. See on-up for more details.
	OnDown pulumi.StringPtrInput
	// Execute script on user login-event. These are available variables that are accessible for the event script: *user *local-address *remote-address *caller-id *called-id *interface.
	OnUp pulumi.StringPtrInput
	// Defines whether a user is allowed to have more than one ppp session at a time yes - a user is not allowed to have more than one ppp session at a time no - the user is allowed to have more than one ppp session at a time default - derive this value from the interface default profile; same as no if this is the interface default profile.
	OnlyOne pulumi.StringPtrInput
	// Firewall  chain name for outgoing packets. The specified chain gets control for  each packet going to the client. The PPP chain should be manually added  and rules with action=jump jump-target=ppp should be added to other  relevant chains in order for this feature to work. For more information  look at the Examples section.
	OutgoingFilter pulumi.StringPtrInput
	// Name of parent simple queue.
	ParentQueue pulumi.StringPtrInput
	// Queue types.
	QueueType pulumi.StringPtrInput
	// Rate limitation in form of rx-rate[/tx-rate]  [rx-burst-rate[/tx-burst-rate] [rx-burst-threshold[/tx-burst-threshold]  [rx-burst-time[/tx-burst-time] [priority] [rx-rate-min[/tx-rate-min]]]] from the point of view of the router (so 'rx' is client upload, and  'tx' is client download). All rates are measured in bits per second,  unless followed by optional 'k' suffix (kilobits per second) or 'M'  suffix (megabits per second). If tx-rate is not specified, rx-rate  serves as tx-rate too. The same applies for tx-burst-rate,  tx-burst-threshold and tx-burst-time. If both rx-burst-threshold and  tx-burst-threshold are not specified (but burst-rate is specified),  rx-rate and tx-rate are used as burst thresholds. If both rx-burst-time  and tx-burst-time are not specified, 1s is used as default. Priority  takes values 1..8, where 1 implies the highest priority, but 8 - the  lowest. If rx-rate-min and tx-rate-min are not specified rx-rate and  tx-rate values are used. The rx-rate-min and tx-rate-min values can not  exceed rx-rate and tx-rate values.
	RateLimit pulumi.StringPtrInput
	// Tunnel address or name of the pool from which address is assigned to remote ppp interface.
	RemoteAddress pulumi.StringPtrInput
	// Assign prefix from IPv6 pool to the client and install corresponding IPv6 route.
	RemoteIpv6PrefixPool pulumi.StringPtrInput
	// Maximum time the connection can stay up. By default no time limit is set.
	SessionTimeout pulumi.StringPtrInput
	// Specifies whether to use data compression or not. yes - enable data compression no - disable data compression default - derive this value from the interface default profile; same as no if this is the interface default profile This setting does not affect OVPN tunnels.
	UseCompression pulumi.StringPtrInput
	// Specifies whether to use data encryption or not. yes - enable data encryption no - disable data encryption default - derive this value from the interface default profile; same as no if this is the interface default profile require - explicitly requires encryption This setting does not work on OVPN and SSTP tunnels.
	UseEncryption pulumi.StringPtrInput
	// Specifies whether to allow IPv6. By default is enabled if IPv6 package is installed. yes - enable IPv6 support no - disable IPv6 support default - derive this value from the interface default profile; same as no if this is the interface default profile require - explicitly requires IPv6 support.
	UseIpv6 pulumi.StringPtrInput
	// Specifies whether to allow MPLS over PPP. yes - enable MPLS support no - disable MPLS support default - derive this value from the interface default profile; same as no if this is the interface default profile require - explicitly requires MPLS support
	UseMpls pulumi.StringPtrInput
	// Specifies whether to allow UPnP.
	UseUpnp pulumi.StringPtrInput
	// IP address of the WINS server to supply to Windows clients.
	WinsServers pulumi.StringArrayInput
	// contains filtered or unexported fields
}

func (ProfileState) ElementType

func (ProfileState) ElementType() reflect.Type

type Secret

type Secret struct {
	pulumi.CustomResourceState

	// For PPTP and L2TP it is the IP address a client must connect from. For PPPoE it is the MAC address (written in CAPITAL letters) a client must  connect from. For ISDN it is the caller's number (that may or may not be  provided by the operator) the client may dial-in from.
	CallerId pulumi.StringPtrOutput `pulumi:"callerId"`
	Comment  pulumi.StringPtrOutput `pulumi:"comment"`
	Disabled pulumi.BoolPtrOutput   `pulumi:"disabled"`
	// IPv6 routes.
	Ipv6Routes           pulumi.StringArrayOutput `pulumi:"ipv6Routes"`
	LastCallerId         pulumi.StringOutput      `pulumi:"lastCallerId"`
	LastDisconnectReason pulumi.StringOutput      `pulumi:"lastDisconnectReason"`
	LastLoggedOut        pulumi.StringOutput      `pulumi:"lastLoggedOut"`
	// Maximal amount of bytes for a session that client can upload.
	LimitBytesIn pulumi.IntPtrOutput `pulumi:"limitBytesIn"`
	// Maximal amount of bytes for a session that client can download.
	LimitBytesOut pulumi.IntPtrOutput `pulumi:"limitBytesOut"`
	// IP address that will be set locally on ppp interface.
	LocalAddress pulumi.StringPtrOutput `pulumi:"localAddress"`
	// Name used for authentication.
	Name pulumi.StringOutput `pulumi:"name"`
	// Password used for authentication.
	Password pulumi.StringPtrOutput `pulumi:"password"`
	// Which user profile to use.
	Profile pulumi.StringPtrOutput `pulumi:"profile"`
	// IP address that will be assigned to remote ppp interface.
	RemoteAddress pulumi.StringPtrOutput `pulumi:"remoteAddress"`
	// IPv6 prefix assigned to ppp client. Prefix is added to ND prefix list enabling stateless address auto-configuration on ppp interface.Available starting from v5.0.
	RemoteIpv6Prefix pulumi.StringPtrOutput `pulumi:"remoteIpv6Prefix"`
	// Routes  that appear on the server when the client is connected. The route  format is: dst-address gateway metric (for example, 10.1.0.0/ 24  10.0.0.1 1). Other syntax is not acceptable since it can be represented  in incorrect way. Several routes may be specified separated with commas.  This parameter will be ignored for OpenVPN.
	Routes pulumi.StringArrayOutput `pulumi:"routes"`
	// Specifies the services that particular user will be able to use.
	Service pulumi.StringPtrOutput `pulumi:"service"`
	// contains filtered or unexported fields
}

## Example Usage

```go package main

import (

"github.com/pulumi/pulumi-routeros/sdk/go/routeros/Ppp"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := Ppp.NewSecret(ctx, "test", &Ppp.SecretArgs{
			Password: pulumi.String("123"),
			Profile:  pulumi.String("default"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

#The ID can be found via API or the terminal #The command for the terminal is -> :put [/ppp/secret get [print show-ids]]

```sh

$ pulumi import routeros:Ppp/secret:Secret test *6

```

func GetSecret

func GetSecret(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *SecretState, opts ...pulumi.ResourceOption) (*Secret, error)

GetSecret gets an existing Secret resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewSecret

func NewSecret(ctx *pulumi.Context,
	name string, args *SecretArgs, opts ...pulumi.ResourceOption) (*Secret, error)

NewSecret registers a new resource with the given unique name, arguments, and options.

func (*Secret) ElementType

func (*Secret) ElementType() reflect.Type

func (*Secret) ToSecretOutput

func (i *Secret) ToSecretOutput() SecretOutput

func (*Secret) ToSecretOutputWithContext

func (i *Secret) ToSecretOutputWithContext(ctx context.Context) SecretOutput

type SecretArgs

type SecretArgs struct {

	// For PPTP and L2TP it is the IP address a client must connect from. For PPPoE it is the MAC address (written in CAPITAL letters) a client must  connect from. For ISDN it is the caller's number (that may or may not be  provided by the operator) the client may dial-in from.
	CallerId pulumi.StringPtrInput
	Comment  pulumi.StringPtrInput
	Disabled pulumi.BoolPtrInput
	// IPv6 routes.
	Ipv6Routes pulumi.StringArrayInput
	// Maximal amount of bytes for a session that client can upload.
	LimitBytesIn pulumi.IntPtrInput
	// Maximal amount of bytes for a session that client can download.
	LimitBytesOut pulumi.IntPtrInput
	// IP address that will be set locally on ppp interface.
	LocalAddress pulumi.StringPtrInput
	// Name used for authentication.
	Name pulumi.StringPtrInput
	// Password used for authentication.
	Password pulumi.StringPtrInput
	// Which user profile to use.
	Profile pulumi.StringPtrInput
	// IP address that will be assigned to remote ppp interface.
	RemoteAddress pulumi.StringPtrInput
	// IPv6 prefix assigned to ppp client. Prefix is added to ND prefix list enabling stateless address auto-configuration on ppp interface.Available starting from v5.0.
	RemoteIpv6Prefix pulumi.StringPtrInput
	// Routes  that appear on the server when the client is connected. The route  format is: dst-address gateway metric (for example, 10.1.0.0/ 24  10.0.0.1 1). Other syntax is not acceptable since it can be represented  in incorrect way. Several routes may be specified separated with commas.  This parameter will be ignored for OpenVPN.
	Routes pulumi.StringArrayInput
	// Specifies the services that particular user will be able to use.
	Service pulumi.StringPtrInput
	// contains filtered or unexported fields
}

The set of arguments for constructing a Secret resource.

func (SecretArgs) ElementType

func (SecretArgs) ElementType() reflect.Type

type SecretArray

type SecretArray []SecretInput

func (SecretArray) ElementType

func (SecretArray) ElementType() reflect.Type

func (SecretArray) ToSecretArrayOutput

func (i SecretArray) ToSecretArrayOutput() SecretArrayOutput

func (SecretArray) ToSecretArrayOutputWithContext

func (i SecretArray) ToSecretArrayOutputWithContext(ctx context.Context) SecretArrayOutput

type SecretArrayInput

type SecretArrayInput interface {
	pulumi.Input

	ToSecretArrayOutput() SecretArrayOutput
	ToSecretArrayOutputWithContext(context.Context) SecretArrayOutput
}

SecretArrayInput is an input type that accepts SecretArray and SecretArrayOutput values. You can construct a concrete instance of `SecretArrayInput` via:

SecretArray{ SecretArgs{...} }

type SecretArrayOutput

type SecretArrayOutput struct{ *pulumi.OutputState }

func (SecretArrayOutput) ElementType

func (SecretArrayOutput) ElementType() reflect.Type

func (SecretArrayOutput) Index

func (SecretArrayOutput) ToSecretArrayOutput

func (o SecretArrayOutput) ToSecretArrayOutput() SecretArrayOutput

func (SecretArrayOutput) ToSecretArrayOutputWithContext

func (o SecretArrayOutput) ToSecretArrayOutputWithContext(ctx context.Context) SecretArrayOutput

type SecretInput

type SecretInput interface {
	pulumi.Input

	ToSecretOutput() SecretOutput
	ToSecretOutputWithContext(ctx context.Context) SecretOutput
}

type SecretMap

type SecretMap map[string]SecretInput

func (SecretMap) ElementType

func (SecretMap) ElementType() reflect.Type

func (SecretMap) ToSecretMapOutput

func (i SecretMap) ToSecretMapOutput() SecretMapOutput

func (SecretMap) ToSecretMapOutputWithContext

func (i SecretMap) ToSecretMapOutputWithContext(ctx context.Context) SecretMapOutput

type SecretMapInput

type SecretMapInput interface {
	pulumi.Input

	ToSecretMapOutput() SecretMapOutput
	ToSecretMapOutputWithContext(context.Context) SecretMapOutput
}

SecretMapInput is an input type that accepts SecretMap and SecretMapOutput values. You can construct a concrete instance of `SecretMapInput` via:

SecretMap{ "key": SecretArgs{...} }

type SecretMapOutput

type SecretMapOutput struct{ *pulumi.OutputState }

func (SecretMapOutput) ElementType

func (SecretMapOutput) ElementType() reflect.Type

func (SecretMapOutput) MapIndex

func (SecretMapOutput) ToSecretMapOutput

func (o SecretMapOutput) ToSecretMapOutput() SecretMapOutput

func (SecretMapOutput) ToSecretMapOutputWithContext

func (o SecretMapOutput) ToSecretMapOutputWithContext(ctx context.Context) SecretMapOutput

type SecretOutput

type SecretOutput struct{ *pulumi.OutputState }

func (SecretOutput) CallerId

func (o SecretOutput) CallerId() pulumi.StringPtrOutput

For PPTP and L2TP it is the IP address a client must connect from. For PPPoE it is the MAC address (written in CAPITAL letters) a client must connect from. For ISDN it is the caller's number (that may or may not be provided by the operator) the client may dial-in from.

func (SecretOutput) Comment

func (o SecretOutput) Comment() pulumi.StringPtrOutput

func (SecretOutput) Disabled

func (o SecretOutput) Disabled() pulumi.BoolPtrOutput

func (SecretOutput) ElementType

func (SecretOutput) ElementType() reflect.Type

func (SecretOutput) Ipv6Routes

func (o SecretOutput) Ipv6Routes() pulumi.StringArrayOutput

IPv6 routes.

func (SecretOutput) LastCallerId

func (o SecretOutput) LastCallerId() pulumi.StringOutput

func (SecretOutput) LastDisconnectReason

func (o SecretOutput) LastDisconnectReason() pulumi.StringOutput

func (SecretOutput) LastLoggedOut

func (o SecretOutput) LastLoggedOut() pulumi.StringOutput

func (SecretOutput) LimitBytesIn

func (o SecretOutput) LimitBytesIn() pulumi.IntPtrOutput

Maximal amount of bytes for a session that client can upload.

func (SecretOutput) LimitBytesOut

func (o SecretOutput) LimitBytesOut() pulumi.IntPtrOutput

Maximal amount of bytes for a session that client can download.

func (SecretOutput) LocalAddress

func (o SecretOutput) LocalAddress() pulumi.StringPtrOutput

IP address that will be set locally on ppp interface.

func (SecretOutput) Name

func (o SecretOutput) Name() pulumi.StringOutput

Name used for authentication.

func (SecretOutput) Password

func (o SecretOutput) Password() pulumi.StringPtrOutput

Password used for authentication.

func (SecretOutput) Profile

func (o SecretOutput) Profile() pulumi.StringPtrOutput

Which user profile to use.

func (SecretOutput) RemoteAddress

func (o SecretOutput) RemoteAddress() pulumi.StringPtrOutput

IP address that will be assigned to remote ppp interface.

func (SecretOutput) RemoteIpv6Prefix

func (o SecretOutput) RemoteIpv6Prefix() pulumi.StringPtrOutput

IPv6 prefix assigned to ppp client. Prefix is added to ND prefix list enabling stateless address auto-configuration on ppp interface.Available starting from v5.0.

func (SecretOutput) Routes

Routes that appear on the server when the client is connected. The route format is: dst-address gateway metric (for example, 10.1.0.0/ 24 10.0.0.1 1). Other syntax is not acceptable since it can be represented in incorrect way. Several routes may be specified separated with commas. This parameter will be ignored for OpenVPN.

func (SecretOutput) Service

func (o SecretOutput) Service() pulumi.StringPtrOutput

Specifies the services that particular user will be able to use.

func (SecretOutput) ToSecretOutput

func (o SecretOutput) ToSecretOutput() SecretOutput

func (SecretOutput) ToSecretOutputWithContext

func (o SecretOutput) ToSecretOutputWithContext(ctx context.Context) SecretOutput

type SecretState

type SecretState struct {

	// For PPTP and L2TP it is the IP address a client must connect from. For PPPoE it is the MAC address (written in CAPITAL letters) a client must  connect from. For ISDN it is the caller's number (that may or may not be  provided by the operator) the client may dial-in from.
	CallerId pulumi.StringPtrInput
	Comment  pulumi.StringPtrInput
	Disabled pulumi.BoolPtrInput
	// IPv6 routes.
	Ipv6Routes           pulumi.StringArrayInput
	LastCallerId         pulumi.StringPtrInput
	LastDisconnectReason pulumi.StringPtrInput
	LastLoggedOut        pulumi.StringPtrInput
	// Maximal amount of bytes for a session that client can upload.
	LimitBytesIn pulumi.IntPtrInput
	// Maximal amount of bytes for a session that client can download.
	LimitBytesOut pulumi.IntPtrInput
	// IP address that will be set locally on ppp interface.
	LocalAddress pulumi.StringPtrInput
	// Name used for authentication.
	Name pulumi.StringPtrInput
	// Password used for authentication.
	Password pulumi.StringPtrInput
	// Which user profile to use.
	Profile pulumi.StringPtrInput
	// IP address that will be assigned to remote ppp interface.
	RemoteAddress pulumi.StringPtrInput
	// IPv6 prefix assigned to ppp client. Prefix is added to ND prefix list enabling stateless address auto-configuration on ppp interface.Available starting from v5.0.
	RemoteIpv6Prefix pulumi.StringPtrInput
	// Routes  that appear on the server when the client is connected. The route  format is: dst-address gateway metric (for example, 10.1.0.0/ 24  10.0.0.1 1). Other syntax is not acceptable since it can be represented  in incorrect way. Several routes may be specified separated with commas.  This parameter will be ignored for OpenVPN.
	Routes pulumi.StringArrayInput
	// Specifies the services that particular user will be able to use.
	Service pulumi.StringPtrInput
	// contains filtered or unexported fields
}

func (SecretState) ElementType

func (SecretState) ElementType() reflect.Type

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL