Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Fortios
  3. API Docs
  4. system
  5. Wccp
Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse
pulumiverse/pulumi-fortios

fortios.system.Wccp

Explore with Pulumi AI

Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse
pulumiverse/pulumi-fortios

Configure WCCP.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as fortios from "@pulumiverse/fortios";

const trname = new fortios.system.Wccp("trname", {
    assignmentBucketFormat: "cisco-implementation",
    assignmentDstaddrMask: "0.0.0.0",
    assignmentMethod: "HASH",
    assignmentSrcaddrMask: "0.0.23.65",
    assignmentWeight: 0,
    authentication: "disable",
    cacheEngineMethod: "GRE",
    cacheId: "1.1.1.1",
    forwardMethod: "GRE",
    groupAddress: "0.0.0.0",
    primaryHash: "dst-ip",
    priority: 0,
    protocol: 0,
    returnMethod: "GRE",
    routerId: "1.1.1.1",
    routerList: "\"1.0.0.0\" ",
    serverType: "forward",
    serviceId: "1",
    serviceType: "auto",
});
Copy
import pulumi
import pulumiverse_fortios as fortios

trname = fortios.system.Wccp("trname",
    assignment_bucket_format="cisco-implementation",
    assignment_dstaddr_mask="0.0.0.0",
    assignment_method="HASH",
    assignment_srcaddr_mask="0.0.23.65",
    assignment_weight=0,
    authentication="disable",
    cache_engine_method="GRE",
    cache_id="1.1.1.1",
    forward_method="GRE",
    group_address="0.0.0.0",
    primary_hash="dst-ip",
    priority=0,
    protocol=0,
    return_method="GRE",
    router_id="1.1.1.1",
    router_list="\"1.0.0.0\" ",
    server_type="forward",
    service_id="1",
    service_type="auto")
Copy
package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-fortios/sdk/go/fortios/system"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := system.NewWccp(ctx, "trname", &system.WccpArgs{
			AssignmentBucketFormat: pulumi.String("cisco-implementation"),
			AssignmentDstaddrMask:  pulumi.String("0.0.0.0"),
			AssignmentMethod:       pulumi.String("HASH"),
			AssignmentSrcaddrMask:  pulumi.String("0.0.23.65"),
			AssignmentWeight:       pulumi.Int(0),
			Authentication:         pulumi.String("disable"),
			CacheEngineMethod:      pulumi.String("GRE"),
			CacheId:                pulumi.String("1.1.1.1"),
			ForwardMethod:          pulumi.String("GRE"),
			GroupAddress:           pulumi.String("0.0.0.0"),
			PrimaryHash:            pulumi.String("dst-ip"),
			Priority:               pulumi.Int(0),
			Protocol:               pulumi.Int(0),
			ReturnMethod:           pulumi.String("GRE"),
			RouterId:               pulumi.String("1.1.1.1"),
			RouterList:             pulumi.String("\"1.0.0.0\" "),
			ServerType:             pulumi.String("forward"),
			ServiceId:              pulumi.String("1"),
			ServiceType:            pulumi.String("auto"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Fortios = Pulumiverse.Fortios;

return await Deployment.RunAsync(() => 
{
    var trname = new Fortios.System.Wccp("trname", new()
    {
        AssignmentBucketFormat = "cisco-implementation",
        AssignmentDstaddrMask = "0.0.0.0",
        AssignmentMethod = "HASH",
        AssignmentSrcaddrMask = "0.0.23.65",
        AssignmentWeight = 0,
        Authentication = "disable",
        CacheEngineMethod = "GRE",
        CacheId = "1.1.1.1",
        ForwardMethod = "GRE",
        GroupAddress = "0.0.0.0",
        PrimaryHash = "dst-ip",
        Priority = 0,
        Protocol = 0,
        ReturnMethod = "GRE",
        RouterId = "1.1.1.1",
        RouterList = "\"1.0.0.0\" ",
        ServerType = "forward",
        ServiceId = "1",
        ServiceType = "auto",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fortios.system.Wccp;
import com.pulumi.fortios.system.WccpArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var trname = new Wccp("trname", WccpArgs.builder()
            .assignmentBucketFormat("cisco-implementation")
            .assignmentDstaddrMask("0.0.0.0")
            .assignmentMethod("HASH")
            .assignmentSrcaddrMask("0.0.23.65")
            .assignmentWeight(0)
            .authentication("disable")
            .cacheEngineMethod("GRE")
            .cacheId("1.1.1.1")
            .forwardMethod("GRE")
            .groupAddress("0.0.0.0")
            .primaryHash("dst-ip")
            .priority(0)
            .protocol(0)
            .returnMethod("GRE")
            .routerId("1.1.1.1")
            .routerList("\"1.0.0.0\" ")
            .serverType("forward")
            .serviceId("1")
            .serviceType("auto")
            .build());

    }
}
Copy
resources:
  trname:
    type: fortios:system:Wccp
    properties:
      assignmentBucketFormat: cisco-implementation
      assignmentDstaddrMask: 0.0.0.0
      assignmentMethod: HASH
      assignmentSrcaddrMask: 0.0.23.65
      assignmentWeight: 0
      authentication: disable
      cacheEngineMethod: GRE
      cacheId: 1.1.1.1
      forwardMethod: GRE
      groupAddress: 0.0.0.0
      primaryHash: dst-ip
      priority: 0
      protocol: 0
      returnMethod: GRE
      routerId: 1.1.1.1
      routerList: '"1.0.0.0" '
      serverType: forward
      serviceId: '1'
      serviceType: auto
Copy

Create Wccp Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Wccp(name: string, args?: WccpArgs, opts?: CustomResourceOptions);
@overload
def Wccp(resource_name: str,
         args: Optional[WccpArgs] = None,
         opts: Optional[ResourceOptions] = None)

@overload
def Wccp(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         assignment_bucket_format: Optional[str] = None,
         assignment_dstaddr_mask: Optional[str] = None,
         assignment_method: Optional[str] = None,
         assignment_srcaddr_mask: Optional[str] = None,
         assignment_weight: Optional[int] = None,
         authentication: Optional[str] = None,
         cache_engine_method: Optional[str] = None,
         cache_id: Optional[str] = None,
         forward_method: Optional[str] = None,
         group_address: Optional[str] = None,
         password: Optional[str] = None,
         ports: Optional[str] = None,
         ports_defined: Optional[str] = None,
         primary_hash: Optional[str] = None,
         priority: Optional[int] = None,
         protocol: Optional[int] = None,
         return_method: Optional[str] = None,
         router_id: Optional[str] = None,
         router_list: Optional[str] = None,
         server_list: Optional[str] = None,
         server_type: Optional[str] = None,
         service_id: Optional[str] = None,
         service_type: Optional[str] = None,
         vdomparam: Optional[str] = None)
func NewWccp(ctx *Context, name string, args *WccpArgs, opts ...ResourceOption) (*Wccp, error)
public Wccp(string name, WccpArgs? args = null, CustomResourceOptions? opts = null)
public Wccp(String name, WccpArgs args)
public Wccp(String name, WccpArgs args, CustomResourceOptions options)

type: fortios:system:Wccp
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args WccpArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args WccpArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args WccpArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args WccpArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. WccpArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var wccpResource = new Fortios.System.Wccp("wccpResource", new()
{
    AssignmentBucketFormat = "string",
    AssignmentDstaddrMask = "string",
    AssignmentMethod = "string",
    AssignmentSrcaddrMask = "string",
    AssignmentWeight = 0,
    Authentication = "string",
    CacheEngineMethod = "string",
    CacheId = "string",
    ForwardMethod = "string",
    GroupAddress = "string",
    Password = "string",
    Ports = "string",
    PortsDefined = "string",
    PrimaryHash = "string",
    Priority = 0,
    Protocol = 0,
    ReturnMethod = "string",
    RouterId = "string",
    RouterList = "string",
    ServerList = "string",
    ServerType = "string",
    ServiceId = "string",
    ServiceType = "string",
    Vdomparam = "string",
});
Copy
example, err := system.NewWccp(ctx, "wccpResource", &system.WccpArgs{
	AssignmentBucketFormat: pulumi.String("string"),
	AssignmentDstaddrMask:  pulumi.String("string"),
	AssignmentMethod:       pulumi.String("string"),
	AssignmentSrcaddrMask:  pulumi.String("string"),
	AssignmentWeight:       pulumi.Int(0),
	Authentication:         pulumi.String("string"),
	CacheEngineMethod:      pulumi.String("string"),
	CacheId:                pulumi.String("string"),
	ForwardMethod:          pulumi.String("string"),
	GroupAddress:           pulumi.String("string"),
	Password:               pulumi.String("string"),
	Ports:                  pulumi.String("string"),
	PortsDefined:           pulumi.String("string"),
	PrimaryHash:            pulumi.String("string"),
	Priority:               pulumi.Int(0),
	Protocol:               pulumi.Int(0),
	ReturnMethod:           pulumi.String("string"),
	RouterId:               pulumi.String("string"),
	RouterList:             pulumi.String("string"),
	ServerList:             pulumi.String("string"),
	ServerType:             pulumi.String("string"),
	ServiceId:              pulumi.String("string"),
	ServiceType:            pulumi.String("string"),
	Vdomparam:              pulumi.String("string"),
})
Copy
var wccpResource = new Wccp("wccpResource", WccpArgs.builder()
    .assignmentBucketFormat("string")
    .assignmentDstaddrMask("string")
    .assignmentMethod("string")
    .assignmentSrcaddrMask("string")
    .assignmentWeight(0)
    .authentication("string")
    .cacheEngineMethod("string")
    .cacheId("string")
    .forwardMethod("string")
    .groupAddress("string")
    .password("string")
    .ports("string")
    .portsDefined("string")
    .primaryHash("string")
    .priority(0)
    .protocol(0)
    .returnMethod("string")
    .routerId("string")
    .routerList("string")
    .serverList("string")
    .serverType("string")
    .serviceId("string")
    .serviceType("string")
    .vdomparam("string")
    .build());
Copy
wccp_resource = fortios.system.Wccp("wccpResource",
    assignment_bucket_format="string",
    assignment_dstaddr_mask="string",
    assignment_method="string",
    assignment_srcaddr_mask="string",
    assignment_weight=0,
    authentication="string",
    cache_engine_method="string",
    cache_id="string",
    forward_method="string",
    group_address="string",
    password="string",
    ports="string",
    ports_defined="string",
    primary_hash="string",
    priority=0,
    protocol=0,
    return_method="string",
    router_id="string",
    router_list="string",
    server_list="string",
    server_type="string",
    service_id="string",
    service_type="string",
    vdomparam="string")
Copy
const wccpResource = new fortios.system.Wccp("wccpResource", {
    assignmentBucketFormat: "string",
    assignmentDstaddrMask: "string",
    assignmentMethod: "string",
    assignmentSrcaddrMask: "string",
    assignmentWeight: 0,
    authentication: "string",
    cacheEngineMethod: "string",
    cacheId: "string",
    forwardMethod: "string",
    groupAddress: "string",
    password: "string",
    ports: "string",
    portsDefined: "string",
    primaryHash: "string",
    priority: 0,
    protocol: 0,
    returnMethod: "string",
    routerId: "string",
    routerList: "string",
    serverList: "string",
    serverType: "string",
    serviceId: "string",
    serviceType: "string",
    vdomparam: "string",
});
Copy
type: fortios:system:Wccp
properties:
    assignmentBucketFormat: string
    assignmentDstaddrMask: string
    assignmentMethod: string
    assignmentSrcaddrMask: string
    assignmentWeight: 0
    authentication: string
    cacheEngineMethod: string
    cacheId: string
    forwardMethod: string
    groupAddress: string
    password: string
    ports: string
    portsDefined: string
    primaryHash: string
    priority: 0
    protocol: 0
    returnMethod: string
    routerId: string
    routerList: string
    serverList: string
    serverType: string
    serviceId: string
    serviceType: string
    vdomparam: string
Copy

Wccp Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Wccp resource accepts the following input properties:

AssignmentBucketFormat string
Assignment bucket format for the WCCP cache engine. Valid values: wccp-v2, cisco-implementation.
AssignmentDstaddrMask string
Assignment destination address mask.
AssignmentMethod string
Hash key assignment preference. Valid values: HASH, MASK, any.
AssignmentSrcaddrMask string
Assignment source address mask.
AssignmentWeight int
Assignment of hash weight/ratio for the WCCP cache engine.
Authentication string
Enable/disable MD5 authentication. Valid values: enable, disable.
CacheEngineMethod string
Method used to forward traffic to the routers or to return to the cache engine. Valid values: GRE, L2.
CacheId string
IP address known to all routers. If the addresses are the same, use the default 0.0.0.0.
ForwardMethod string
Method used to forward traffic to the cache servers. Valid values: GRE, L2, any.
GroupAddress string
IP multicast address used by the cache routers. For the FortiGate to ignore multicast WCCP traffic, use the default 0.0.0.0.
Password string
Password for MD5 authentication.
Ports string
Service ports.
PortsDefined string
Match method. Valid values: source, destination.
PrimaryHash string
Hash method. Valid values: src-ip, dst-ip, src-port, dst-port.
Priority int
Service priority.
Protocol int
Service protocol.
ReturnMethod string
Method used to decline a redirected packet and return it to the FortiGate. Valid values: GRE, L2, any.
RouterId string
IP address known to all cache engines. If all cache engines connect to the same FortiGate interface, use the default 0.0.0.0.
RouterList string
IP addresses of one or more WCCP routers.
ServerList string
IP addresses and netmasks for up to four cache servers.
ServerType string
Cache server type. Valid values: forward, proxy.
ServiceId Changes to this property will trigger replacement. string
Service ID.
ServiceType string
WCCP service type used by the cache server for logical interception and redirection of traffic. Valid values: auto, standard, dynamic.
Vdomparam Changes to this property will trigger replacement. string
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
AssignmentBucketFormat string
Assignment bucket format for the WCCP cache engine. Valid values: wccp-v2, cisco-implementation.
AssignmentDstaddrMask string
Assignment destination address mask.
AssignmentMethod string
Hash key assignment preference. Valid values: HASH, MASK, any.
AssignmentSrcaddrMask string
Assignment source address mask.
AssignmentWeight int
Assignment of hash weight/ratio for the WCCP cache engine.
Authentication string
Enable/disable MD5 authentication. Valid values: enable, disable.
CacheEngineMethod string
Method used to forward traffic to the routers or to return to the cache engine. Valid values: GRE, L2.
CacheId string
IP address known to all routers. If the addresses are the same, use the default 0.0.0.0.
ForwardMethod string
Method used to forward traffic to the cache servers. Valid values: GRE, L2, any.
GroupAddress string
IP multicast address used by the cache routers. For the FortiGate to ignore multicast WCCP traffic, use the default 0.0.0.0.
Password string
Password for MD5 authentication.
Ports string
Service ports.
PortsDefined string
Match method. Valid values: source, destination.
PrimaryHash string
Hash method. Valid values: src-ip, dst-ip, src-port, dst-port.
Priority int
Service priority.
Protocol int
Service protocol.
ReturnMethod string
Method used to decline a redirected packet and return it to the FortiGate. Valid values: GRE, L2, any.
RouterId string
IP address known to all cache engines. If all cache engines connect to the same FortiGate interface, use the default 0.0.0.0.
RouterList string
IP addresses of one or more WCCP routers.
ServerList string
IP addresses and netmasks for up to four cache servers.
ServerType string
Cache server type. Valid values: forward, proxy.
ServiceId Changes to this property will trigger replacement. string
Service ID.
ServiceType string
WCCP service type used by the cache server for logical interception and redirection of traffic. Valid values: auto, standard, dynamic.
Vdomparam Changes to this property will trigger replacement. string
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
assignmentBucketFormat String
Assignment bucket format for the WCCP cache engine. Valid values: wccp-v2, cisco-implementation.
assignmentDstaddrMask String
Assignment destination address mask.
assignmentMethod String
Hash key assignment preference. Valid values: HASH, MASK, any.
assignmentSrcaddrMask String
Assignment source address mask.
assignmentWeight Integer
Assignment of hash weight/ratio for the WCCP cache engine.
authentication String
Enable/disable MD5 authentication. Valid values: enable, disable.
cacheEngineMethod String
Method used to forward traffic to the routers or to return to the cache engine. Valid values: GRE, L2.
cacheId String
IP address known to all routers. If the addresses are the same, use the default 0.0.0.0.
forwardMethod String
Method used to forward traffic to the cache servers. Valid values: GRE, L2, any.
groupAddress String
IP multicast address used by the cache routers. For the FortiGate to ignore multicast WCCP traffic, use the default 0.0.0.0.
password String
Password for MD5 authentication.
ports String
Service ports.
portsDefined String
Match method. Valid values: source, destination.
primaryHash String
Hash method. Valid values: src-ip, dst-ip, src-port, dst-port.
priority Integer
Service priority.
protocol Integer
Service protocol.
returnMethod String
Method used to decline a redirected packet and return it to the FortiGate. Valid values: GRE, L2, any.
routerId String
IP address known to all cache engines. If all cache engines connect to the same FortiGate interface, use the default 0.0.0.0.
routerList String
IP addresses of one or more WCCP routers.
serverList String
IP addresses and netmasks for up to four cache servers.
serverType String
Cache server type. Valid values: forward, proxy.
serviceId Changes to this property will trigger replacement. String
Service ID.
serviceType String
WCCP service type used by the cache server for logical interception and redirection of traffic. Valid values: auto, standard, dynamic.
vdomparam Changes to this property will trigger replacement. String
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
assignmentBucketFormat string
Assignment bucket format for the WCCP cache engine. Valid values: wccp-v2, cisco-implementation.
assignmentDstaddrMask string
Assignment destination address mask.
assignmentMethod string
Hash key assignment preference. Valid values: HASH, MASK, any.
assignmentSrcaddrMask string
Assignment source address mask.
assignmentWeight number
Assignment of hash weight/ratio for the WCCP cache engine.
authentication string
Enable/disable MD5 authentication. Valid values: enable, disable.
cacheEngineMethod string
Method used to forward traffic to the routers or to return to the cache engine. Valid values: GRE, L2.
cacheId string
IP address known to all routers. If the addresses are the same, use the default 0.0.0.0.
forwardMethod string
Method used to forward traffic to the cache servers. Valid values: GRE, L2, any.
groupAddress string
IP multicast address used by the cache routers. For the FortiGate to ignore multicast WCCP traffic, use the default 0.0.0.0.
password string
Password for MD5 authentication.
ports string
Service ports.
portsDefined string
Match method. Valid values: source, destination.
primaryHash string
Hash method. Valid values: src-ip, dst-ip, src-port, dst-port.
priority number
Service priority.
protocol number
Service protocol.
returnMethod string
Method used to decline a redirected packet and return it to the FortiGate. Valid values: GRE, L2, any.
routerId string
IP address known to all cache engines. If all cache engines connect to the same FortiGate interface, use the default 0.0.0.0.
routerList string
IP addresses of one or more WCCP routers.
serverList string
IP addresses and netmasks for up to four cache servers.
serverType string
Cache server type. Valid values: forward, proxy.
serviceId Changes to this property will trigger replacement. string
Service ID.
serviceType string
WCCP service type used by the cache server for logical interception and redirection of traffic. Valid values: auto, standard, dynamic.
vdomparam Changes to this property will trigger replacement. string
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
assignment_bucket_format str
Assignment bucket format for the WCCP cache engine. Valid values: wccp-v2, cisco-implementation.
assignment_dstaddr_mask str
Assignment destination address mask.
assignment_method str
Hash key assignment preference. Valid values: HASH, MASK, any.
assignment_srcaddr_mask str
Assignment source address mask.
assignment_weight int
Assignment of hash weight/ratio for the WCCP cache engine.
authentication str
Enable/disable MD5 authentication. Valid values: enable, disable.
cache_engine_method str
Method used to forward traffic to the routers or to return to the cache engine. Valid values: GRE, L2.
cache_id str
IP address known to all routers. If the addresses are the same, use the default 0.0.0.0.
forward_method str
Method used to forward traffic to the cache servers. Valid values: GRE, L2, any.
group_address str
IP multicast address used by the cache routers. For the FortiGate to ignore multicast WCCP traffic, use the default 0.0.0.0.
password str
Password for MD5 authentication.
ports str
Service ports.
ports_defined str
Match method. Valid values: source, destination.
primary_hash str
Hash method. Valid values: src-ip, dst-ip, src-port, dst-port.
priority int
Service priority.
protocol int
Service protocol.
return_method str
Method used to decline a redirected packet and return it to the FortiGate. Valid values: GRE, L2, any.
router_id str
IP address known to all cache engines. If all cache engines connect to the same FortiGate interface, use the default 0.0.0.0.
router_list str
IP addresses of one or more WCCP routers.
server_list str
IP addresses and netmasks for up to four cache servers.
server_type str
Cache server type. Valid values: forward, proxy.
service_id Changes to this property will trigger replacement. str
Service ID.
service_type str
WCCP service type used by the cache server for logical interception and redirection of traffic. Valid values: auto, standard, dynamic.
vdomparam Changes to this property will trigger replacement. str
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
assignmentBucketFormat String
Assignment bucket format for the WCCP cache engine. Valid values: wccp-v2, cisco-implementation.
assignmentDstaddrMask String
Assignment destination address mask.
assignmentMethod String
Hash key assignment preference. Valid values: HASH, MASK, any.
assignmentSrcaddrMask String
Assignment source address mask.
assignmentWeight Number
Assignment of hash weight/ratio for the WCCP cache engine.
authentication String
Enable/disable MD5 authentication. Valid values: enable, disable.
cacheEngineMethod String
Method used to forward traffic to the routers or to return to the cache engine. Valid values: GRE, L2.
cacheId String
IP address known to all routers. If the addresses are the same, use the default 0.0.0.0.
forwardMethod String
Method used to forward traffic to the cache servers. Valid values: GRE, L2, any.
groupAddress String
IP multicast address used by the cache routers. For the FortiGate to ignore multicast WCCP traffic, use the default 0.0.0.0.
password String
Password for MD5 authentication.
ports String
Service ports.
portsDefined String
Match method. Valid values: source, destination.
primaryHash String
Hash method. Valid values: src-ip, dst-ip, src-port, dst-port.
priority Number
Service priority.
protocol Number
Service protocol.
returnMethod String
Method used to decline a redirected packet and return it to the FortiGate. Valid values: GRE, L2, any.
routerId String
IP address known to all cache engines. If all cache engines connect to the same FortiGate interface, use the default 0.0.0.0.
routerList String
IP addresses of one or more WCCP routers.
serverList String
IP addresses and netmasks for up to four cache servers.
serverType String
Cache server type. Valid values: forward, proxy.
serviceId Changes to this property will trigger replacement. String
Service ID.
serviceType String
WCCP service type used by the cache server for logical interception and redirection of traffic. Valid values: auto, standard, dynamic.
vdomparam Changes to this property will trigger replacement. String
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.

Outputs

All input properties are implicitly available as output properties. Additionally, the Wccp resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing Wccp Resource

Get an existing Wccp resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: WccpState, opts?: CustomResourceOptions): Wccp
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        assignment_bucket_format: Optional[str] = None,
        assignment_dstaddr_mask: Optional[str] = None,
        assignment_method: Optional[str] = None,
        assignment_srcaddr_mask: Optional[str] = None,
        assignment_weight: Optional[int] = None,
        authentication: Optional[str] = None,
        cache_engine_method: Optional[str] = None,
        cache_id: Optional[str] = None,
        forward_method: Optional[str] = None,
        group_address: Optional[str] = None,
        password: Optional[str] = None,
        ports: Optional[str] = None,
        ports_defined: Optional[str] = None,
        primary_hash: Optional[str] = None,
        priority: Optional[int] = None,
        protocol: Optional[int] = None,
        return_method: Optional[str] = None,
        router_id: Optional[str] = None,
        router_list: Optional[str] = None,
        server_list: Optional[str] = None,
        server_type: Optional[str] = None,
        service_id: Optional[str] = None,
        service_type: Optional[str] = None,
        vdomparam: Optional[str] = None) -> Wccp
func GetWccp(ctx *Context, name string, id IDInput, state *WccpState, opts ...ResourceOption) (*Wccp, error)
public static Wccp Get(string name, Input<string> id, WccpState? state, CustomResourceOptions? opts = null)
public static Wccp get(String name, Output<String> id, WccpState state, CustomResourceOptions options)
resources:  _:    type: fortios:system:Wccp    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AssignmentBucketFormat string
Assignment bucket format for the WCCP cache engine. Valid values: wccp-v2, cisco-implementation.
AssignmentDstaddrMask string
Assignment destination address mask.
AssignmentMethod string
Hash key assignment preference. Valid values: HASH, MASK, any.
AssignmentSrcaddrMask string
Assignment source address mask.
AssignmentWeight int
Assignment of hash weight/ratio for the WCCP cache engine.
Authentication string
Enable/disable MD5 authentication. Valid values: enable, disable.
CacheEngineMethod string
Method used to forward traffic to the routers or to return to the cache engine. Valid values: GRE, L2.
CacheId string
IP address known to all routers. If the addresses are the same, use the default 0.0.0.0.
ForwardMethod string
Method used to forward traffic to the cache servers. Valid values: GRE, L2, any.
GroupAddress string
IP multicast address used by the cache routers. For the FortiGate to ignore multicast WCCP traffic, use the default 0.0.0.0.
Password string
Password for MD5 authentication.
Ports string
Service ports.
PortsDefined string
Match method. Valid values: source, destination.
PrimaryHash string
Hash method. Valid values: src-ip, dst-ip, src-port, dst-port.
Priority int
Service priority.
Protocol int
Service protocol.
ReturnMethod string
Method used to decline a redirected packet and return it to the FortiGate. Valid values: GRE, L2, any.
RouterId string
IP address known to all cache engines. If all cache engines connect to the same FortiGate interface, use the default 0.0.0.0.
RouterList string
IP addresses of one or more WCCP routers.
ServerList string
IP addresses and netmasks for up to four cache servers.
ServerType string
Cache server type. Valid values: forward, proxy.
ServiceId Changes to this property will trigger replacement. string
Service ID.
ServiceType string
WCCP service type used by the cache server for logical interception and redirection of traffic. Valid values: auto, standard, dynamic.
Vdomparam Changes to this property will trigger replacement. string
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
AssignmentBucketFormat string
Assignment bucket format for the WCCP cache engine. Valid values: wccp-v2, cisco-implementation.
AssignmentDstaddrMask string
Assignment destination address mask.
AssignmentMethod string
Hash key assignment preference. Valid values: HASH, MASK, any.
AssignmentSrcaddrMask string
Assignment source address mask.
AssignmentWeight int
Assignment of hash weight/ratio for the WCCP cache engine.
Authentication string
Enable/disable MD5 authentication. Valid values: enable, disable.
CacheEngineMethod string
Method used to forward traffic to the routers or to return to the cache engine. Valid values: GRE, L2.
CacheId string
IP address known to all routers. If the addresses are the same, use the default 0.0.0.0.
ForwardMethod string
Method used to forward traffic to the cache servers. Valid values: GRE, L2, any.
GroupAddress string
IP multicast address used by the cache routers. For the FortiGate to ignore multicast WCCP traffic, use the default 0.0.0.0.
Password string
Password for MD5 authentication.
Ports string
Service ports.
PortsDefined string
Match method. Valid values: source, destination.
PrimaryHash string
Hash method. Valid values: src-ip, dst-ip, src-port, dst-port.
Priority int
Service priority.
Protocol int
Service protocol.
ReturnMethod string
Method used to decline a redirected packet and return it to the FortiGate. Valid values: GRE, L2, any.
RouterId string
IP address known to all cache engines. If all cache engines connect to the same FortiGate interface, use the default 0.0.0.0.
RouterList string
IP addresses of one or more WCCP routers.
ServerList string
IP addresses and netmasks for up to four cache servers.
ServerType string
Cache server type. Valid values: forward, proxy.
ServiceId Changes to this property will trigger replacement. string
Service ID.
ServiceType string
WCCP service type used by the cache server for logical interception and redirection of traffic. Valid values: auto, standard, dynamic.
Vdomparam Changes to this property will trigger replacement. string
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
assignmentBucketFormat String
Assignment bucket format for the WCCP cache engine. Valid values: wccp-v2, cisco-implementation.
assignmentDstaddrMask String
Assignment destination address mask.
assignmentMethod String
Hash key assignment preference. Valid values: HASH, MASK, any.
assignmentSrcaddrMask String
Assignment source address mask.
assignmentWeight Integer
Assignment of hash weight/ratio for the WCCP cache engine.
authentication String
Enable/disable MD5 authentication. Valid values: enable, disable.
cacheEngineMethod String
Method used to forward traffic to the routers or to return to the cache engine. Valid values: GRE, L2.
cacheId String
IP address known to all routers. If the addresses are the same, use the default 0.0.0.0.
forwardMethod String
Method used to forward traffic to the cache servers. Valid values: GRE, L2, any.
groupAddress String
IP multicast address used by the cache routers. For the FortiGate to ignore multicast WCCP traffic, use the default 0.0.0.0.
password String
Password for MD5 authentication.
ports String
Service ports.
portsDefined String
Match method. Valid values: source, destination.
primaryHash String
Hash method. Valid values: src-ip, dst-ip, src-port, dst-port.
priority Integer
Service priority.
protocol Integer
Service protocol.
returnMethod String
Method used to decline a redirected packet and return it to the FortiGate. Valid values: GRE, L2, any.
routerId String
IP address known to all cache engines. If all cache engines connect to the same FortiGate interface, use the default 0.0.0.0.
routerList String
IP addresses of one or more WCCP routers.
serverList String
IP addresses and netmasks for up to four cache servers.
serverType String
Cache server type. Valid values: forward, proxy.
serviceId Changes to this property will trigger replacement. String
Service ID.
serviceType String
WCCP service type used by the cache server for logical interception and redirection of traffic. Valid values: auto, standard, dynamic.
vdomparam Changes to this property will trigger replacement. String
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
assignmentBucketFormat string
Assignment bucket format for the WCCP cache engine. Valid values: wccp-v2, cisco-implementation.
assignmentDstaddrMask string
Assignment destination address mask.
assignmentMethod string
Hash key assignment preference. Valid values: HASH, MASK, any.
assignmentSrcaddrMask string
Assignment source address mask.
assignmentWeight number
Assignment of hash weight/ratio for the WCCP cache engine.
authentication string
Enable/disable MD5 authentication. Valid values: enable, disable.
cacheEngineMethod string
Method used to forward traffic to the routers or to return to the cache engine. Valid values: GRE, L2.
cacheId string
IP address known to all routers. If the addresses are the same, use the default 0.0.0.0.
forwardMethod string
Method used to forward traffic to the cache servers. Valid values: GRE, L2, any.
groupAddress string
IP multicast address used by the cache routers. For the FortiGate to ignore multicast WCCP traffic, use the default 0.0.0.0.
password string
Password for MD5 authentication.
ports string
Service ports.
portsDefined string
Match method. Valid values: source, destination.
primaryHash string
Hash method. Valid values: src-ip, dst-ip, src-port, dst-port.
priority number
Service priority.
protocol number
Service protocol.
returnMethod string
Method used to decline a redirected packet and return it to the FortiGate. Valid values: GRE, L2, any.
routerId string
IP address known to all cache engines. If all cache engines connect to the same FortiGate interface, use the default 0.0.0.0.
routerList string
IP addresses of one or more WCCP routers.
serverList string
IP addresses and netmasks for up to four cache servers.
serverType string
Cache server type. Valid values: forward, proxy.
serviceId Changes to this property will trigger replacement. string
Service ID.
serviceType string
WCCP service type used by the cache server for logical interception and redirection of traffic. Valid values: auto, standard, dynamic.
vdomparam Changes to this property will trigger replacement. string
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
assignment_bucket_format str
Assignment bucket format for the WCCP cache engine. Valid values: wccp-v2, cisco-implementation.
assignment_dstaddr_mask str
Assignment destination address mask.
assignment_method str
Hash key assignment preference. Valid values: HASH, MASK, any.
assignment_srcaddr_mask str
Assignment source address mask.
assignment_weight int
Assignment of hash weight/ratio for the WCCP cache engine.
authentication str
Enable/disable MD5 authentication. Valid values: enable, disable.
cache_engine_method str
Method used to forward traffic to the routers or to return to the cache engine. Valid values: GRE, L2.
cache_id str
IP address known to all routers. If the addresses are the same, use the default 0.0.0.0.
forward_method str
Method used to forward traffic to the cache servers. Valid values: GRE, L2, any.
group_address str
IP multicast address used by the cache routers. For the FortiGate to ignore multicast WCCP traffic, use the default 0.0.0.0.
password str
Password for MD5 authentication.
ports str
Service ports.
ports_defined str
Match method. Valid values: source, destination.
primary_hash str
Hash method. Valid values: src-ip, dst-ip, src-port, dst-port.
priority int
Service priority.
protocol int
Service protocol.
return_method str
Method used to decline a redirected packet and return it to the FortiGate. Valid values: GRE, L2, any.
router_id str
IP address known to all cache engines. If all cache engines connect to the same FortiGate interface, use the default 0.0.0.0.
router_list str
IP addresses of one or more WCCP routers.
server_list str
IP addresses and netmasks for up to four cache servers.
server_type str
Cache server type. Valid values: forward, proxy.
service_id Changes to this property will trigger replacement. str
Service ID.
service_type str
WCCP service type used by the cache server for logical interception and redirection of traffic. Valid values: auto, standard, dynamic.
vdomparam Changes to this property will trigger replacement. str
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
assignmentBucketFormat String
Assignment bucket format for the WCCP cache engine. Valid values: wccp-v2, cisco-implementation.
assignmentDstaddrMask String
Assignment destination address mask.
assignmentMethod String
Hash key assignment preference. Valid values: HASH, MASK, any.
assignmentSrcaddrMask String
Assignment source address mask.
assignmentWeight Number
Assignment of hash weight/ratio for the WCCP cache engine.
authentication String
Enable/disable MD5 authentication. Valid values: enable, disable.
cacheEngineMethod String
Method used to forward traffic to the routers or to return to the cache engine. Valid values: GRE, L2.
cacheId String
IP address known to all routers. If the addresses are the same, use the default 0.0.0.0.
forwardMethod String
Method used to forward traffic to the cache servers. Valid values: GRE, L2, any.
groupAddress String
IP multicast address used by the cache routers. For the FortiGate to ignore multicast WCCP traffic, use the default 0.0.0.0.
password String
Password for MD5 authentication.
ports String
Service ports.
portsDefined String
Match method. Valid values: source, destination.
primaryHash String
Hash method. Valid values: src-ip, dst-ip, src-port, dst-port.
priority Number
Service priority.
protocol Number
Service protocol.
returnMethod String
Method used to decline a redirected packet and return it to the FortiGate. Valid values: GRE, L2, any.
routerId String
IP address known to all cache engines. If all cache engines connect to the same FortiGate interface, use the default 0.0.0.0.
routerList String
IP addresses of one or more WCCP routers.
serverList String
IP addresses and netmasks for up to four cache servers.
serverType String
Cache server type. Valid values: forward, proxy.
serviceId Changes to this property will trigger replacement. String
Service ID.
serviceType String
WCCP service type used by the cache server for logical interception and redirection of traffic. Valid values: auto, standard, dynamic.
vdomparam Changes to this property will trigger replacement. String
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.

Import

System Wccp can be imported using any of these accepted formats:

$ pulumi import fortios:system/wccp:Wccp labelname {{service_id}}
Copy

If you do not want to import arguments of block:

$ export “FORTIOS_IMPORT_TABLE”=“false”

$ pulumi import fortios:system/wccp:Wccp labelname {{service_id}}
Copy

$ unset “FORTIOS_IMPORT_TABLE”

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
fortios pulumiverse/pulumi-fortios
License
Apache-2.0
Notes
This Pulumi package is based on the fortios Terraform Provider.
Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse
pulumiverse/pulumi-fortios