Cisco Meraki v0.2.4, Jun 14 24

Cisco Meraki v0.2.4 published on Friday, Jun 14, 2024 by Pulumi

meraki.devices.getLiveToolsCableTest

Explore with Pulumi AI

Cisco Meraki v0.2.4 published on Friday, Jun 14, 2024 by Pulumi

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as meraki from "@pulumi/meraki";

const example = meraki.devices.getLiveToolsCableTest({
    id: "string",
    serial: "string",
});
export const merakiDevicesLiveToolsCableTestExample = example.then(example => example.item);

import pulumi
import pulumi_meraki as meraki

example = meraki.devices.get_live_tools_cable_test(id="string",
    serial="string")
pulumi.export("merakiDevicesLiveToolsCableTestExample", example.item)

package main

import (
	"github.com/pulumi/pulumi-meraki/sdk/go/meraki/devices"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := devices.GetLiveToolsCableTest(ctx, &devices.GetLiveToolsCableTestArgs{
			Id:     "string",
			Serial: "string",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("merakiDevicesLiveToolsCableTestExample", example.Item)
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Meraki = Pulumi.Meraki;

return await Deployment.RunAsync(() => 
{
    var example = Meraki.Devices.GetLiveToolsCableTest.Invoke(new()
    {
        Id = "string",
        Serial = "string",
    });

    return new Dictionary<string, object?>
    {
        ["merakiDevicesLiveToolsCableTestExample"] = example.Apply(getLiveToolsCableTestResult => getLiveToolsCableTestResult.Item),
    };
});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.meraki.devices.DevicesFunctions;
import com.pulumi.meraki.devices.inputs.GetLiveToolsCableTestArgs;
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) {
        final var example = DevicesFunctions.getLiveToolsCableTest(GetLiveToolsCableTestArgs.builder()
            .id("string")
            .serial("string")
            .build());

        ctx.export("merakiDevicesLiveToolsCableTestExample", example.applyValue(getLiveToolsCableTestResult -> getLiveToolsCableTestResult.item()));
    }
}

variables:
  example:
    fn::invoke:
      Function: meraki:devices:getLiveToolsCableTest
      Arguments:
        id: string
        serial: string
outputs:
  merakiDevicesLiveToolsCableTestExample: ${example.item}

Using getLiveToolsCableTest

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getLiveToolsCableTest(args: GetLiveToolsCableTestArgs, opts?: InvokeOptions): Promise<GetLiveToolsCableTestResult>
function getLiveToolsCableTestOutput(args: GetLiveToolsCableTestOutputArgs, opts?: InvokeOptions): Output<GetLiveToolsCableTestResult>

def get_live_tools_cable_test(id: Optional[str] = None,
                              serial: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetLiveToolsCableTestResult
def get_live_tools_cable_test_output(id: Optional[pulumi.Input[str]] = None,
                              serial: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetLiveToolsCableTestResult]

func GetLiveToolsCableTest(ctx *Context, args *GetLiveToolsCableTestArgs, opts ...InvokeOption) (*GetLiveToolsCableTestResult, error)
func GetLiveToolsCableTestOutput(ctx *Context, args *GetLiveToolsCableTestOutputArgs, opts ...InvokeOption) GetLiveToolsCableTestResultOutput

> Note: This function is named GetLiveToolsCableTest in the Go SDK.

public static class GetLiveToolsCableTest 
{
    public static Task<GetLiveToolsCableTestResult> InvokeAsync(GetLiveToolsCableTestArgs args, InvokeOptions? opts = null)
    public static Output<GetLiveToolsCableTestResult> Invoke(GetLiveToolsCableTestInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetLiveToolsCableTestResult> getLiveToolsCableTest(GetLiveToolsCableTestArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: meraki:devices/getLiveToolsCableTest:getLiveToolsCableTest
  arguments:
    # arguments dictionary

The following arguments are supported:

Id string: id path parameter.
Serial string: serial path parameter.

Id string: id path parameter.
Serial string: serial path parameter.

id String: id path parameter.
serial String: serial path parameter.

id string: id path parameter.
serial string: serial path parameter.

id str: id path parameter.
serial str: serial path parameter.

id String: id path parameter.
serial String: serial path parameter.

getLiveToolsCableTest Result

The following output properties are available:

Id string: id path parameter.
Item GetLiveToolsCableTestItem
Serial string: serial path parameter.

Id string: id path parameter.
Item GetLiveToolsCableTestItem
Serial string: serial path parameter.

id String: id path parameter.
item GetLiveToolsCableTestItem
serial String: serial path parameter.

id string: id path parameter.
item GetLiveToolsCableTestItem
serial string: serial path parameter.

id str: id path parameter.
item GetLiveToolsCableTestItem
serial str: serial path parameter.

id String: id path parameter.
item Property Map
serial String: serial path parameter.

Supporting Types

GetLiveToolsCableTestItem

CableTestId string: Id of the cable test request. Used to check the status of the request.
Error string: An error message for a failed execution
Request GetLiveToolsCableTestItemRequest: Cable test request parameters
Results List<GetLiveToolsCableTestItemResult>: Results of the cable test request, one for each requested port.
Status string: Status of the cable test request.
Url string: GET this url to check the status of your cable test request.

CableTestId string: Id of the cable test request. Used to check the status of the request.
Error string: An error message for a failed execution
Request GetLiveToolsCableTestItemRequest: Cable test request parameters
Results []GetLiveToolsCableTestItemResult: Results of the cable test request, one for each requested port.
Status string: Status of the cable test request.
Url string: GET this url to check the status of your cable test request.

cableTestId String: Id of the cable test request. Used to check the status of the request.
error String: An error message for a failed execution
request GetLiveToolsCableTestItemRequest: Cable test request parameters
results List<GetLiveToolsCableTestItemResult>: Results of the cable test request, one for each requested port.
status String: Status of the cable test request.
url String: GET this url to check the status of your cable test request.

cableTestId string: Id of the cable test request. Used to check the status of the request.
error string: An error message for a failed execution
request GetLiveToolsCableTestItemRequest: Cable test request parameters
results GetLiveToolsCableTestItemResult[]: Results of the cable test request, one for each requested port.
status string: Status of the cable test request.
url string: GET this url to check the status of your cable test request.

cable_test_id str: Id of the cable test request. Used to check the status of the request.
error str: An error message for a failed execution
request GetLiveToolsCableTestItemRequest: Cable test request parameters
results Sequence[GetLiveToolsCableTestItemResult]: Results of the cable test request, one for each requested port.
status str: Status of the cable test request.
url str: GET this url to check the status of your cable test request.

cableTestId String: Id of the cable test request. Used to check the status of the request.
error String: An error message for a failed execution
request Property Map: Cable test request parameters
results List<Property Map>: Results of the cable test request, one for each requested port.
status String: Status of the cable test request.
url String: GET this url to check the status of your cable test request.

GetLiveToolsCableTestItemRequest

Ports List<string>: A list of ports for which to perform the cable test.
Serial string: Device serial number

Ports []string: A list of ports for which to perform the cable test.
Serial string: Device serial number

ports List<String>: A list of ports for which to perform the cable test.
serial String: Device serial number

ports string[]: A list of ports for which to perform the cable test.
serial string: Device serial number

ports Sequence[str]: A list of ports for which to perform the cable test.
serial str: Device serial number

ports List<String>: A list of ports for which to perform the cable test.
serial String: Device serial number

GetLiveToolsCableTestItemResult

Error string: If an error occurred during the cable test, the error message will be populated here.
Pairs List<GetLiveToolsCableTestItemResultPair>: Results for each twisted pair within the cable.
Port string: The port for which the test was performed.
SpeedMbps int: Speed in Mbps. A speed of 0 indicates the port is down or the port speed is automatic.
Status string: The current status of the port. If the cable test is still being performed on the port, "in-progress" is used. If an error occurred during the cable test, "error" is used and the error property will be populated.

Error string: If an error occurred during the cable test, the error message will be populated here.
Pairs []GetLiveToolsCableTestItemResultPair: Results for each twisted pair within the cable.
Port string: The port for which the test was performed.
SpeedMbps int: Speed in Mbps. A speed of 0 indicates the port is down or the port speed is automatic.
Status string: The current status of the port. If the cable test is still being performed on the port, "in-progress" is used. If an error occurred during the cable test, "error" is used and the error property will be populated.

error String: If an error occurred during the cable test, the error message will be populated here.
pairs List<GetLiveToolsCableTestItemResultPair>: Results for each twisted pair within the cable.
port String: The port for which the test was performed.
speedMbps Integer: Speed in Mbps. A speed of 0 indicates the port is down or the port speed is automatic.
status String: The current status of the port. If the cable test is still being performed on the port, "in-progress" is used. If an error occurred during the cable test, "error" is used and the error property will be populated.

error string: If an error occurred during the cable test, the error message will be populated here.
pairs GetLiveToolsCableTestItemResultPair[]: Results for each twisted pair within the cable.
port string: The port for which the test was performed.
speedMbps number: Speed in Mbps. A speed of 0 indicates the port is down or the port speed is automatic.
status string: The current status of the port. If the cable test is still being performed on the port, "in-progress" is used. If an error occurred during the cable test, "error" is used and the error property will be populated.

error str: If an error occurred during the cable test, the error message will be populated here.
pairs Sequence[GetLiveToolsCableTestItemResultPair]: Results for each twisted pair within the cable.
port str: The port for which the test was performed.
speed_mbps int: Speed in Mbps. A speed of 0 indicates the port is down or the port speed is automatic.
status str: The current status of the port. If the cable test is still being performed on the port, "in-progress" is used. If an error occurred during the cable test, "error" is used and the error property will be populated.

error String: If an error occurred during the cable test, the error message will be populated here.
pairs List<Property Map>: Results for each twisted pair within the cable.
port String: The port for which the test was performed.
speedMbps Number: Speed in Mbps. A speed of 0 indicates the port is down or the port speed is automatic.
status String: The current status of the port. If the cable test is still being performed on the port, "in-progress" is used. If an error occurred during the cable test, "error" is used and the error property will be populated.

GetLiveToolsCableTestItemResultPair

Index int: The index of the twisted pair tested.
LengthMeters int: The detected length of the twisted pair.
Status string: The test result of the twisted pair tested.

Index int: The index of the twisted pair tested.
LengthMeters int: The detected length of the twisted pair.
Status string: The test result of the twisted pair tested.

index Integer: The index of the twisted pair tested.
lengthMeters Integer: The detected length of the twisted pair.
status String: The test result of the twisted pair tested.

index number: The index of the twisted pair tested.
lengthMeters number: The detected length of the twisted pair.
status string: The test result of the twisted pair tested.

index int: The index of the twisted pair tested.
length_meters int: The detected length of the twisted pair.
status str: The test result of the twisted pair tested.

index Number: The index of the twisted pair tested.
lengthMeters Number: The detected length of the twisted pair.
status String: The test result of the twisted pair tested.

Package Details

Repository: meraki pulumi/pulumi-meraki
License: Apache-2.0
Notes: This Pulumi package is based on the meraki Terraform Provider.

Cisco Meraki v0.2.4 published on Friday, Jun 14, 2024 by Pulumi

pulumi/pulumi-meraki

meraki.devices.getLiveToolsCableTest

On this page

On this page

Example Usage

Using getLiveToolsCableTest

getLiveToolsCableTest Result

Supporting Types

GetLiveToolsCableTestItem

GetLiveToolsCableTestItemRequest

GetLiveToolsCableTestItemResult

GetLiveToolsCableTestItemResultPair

Package Details

On this page

On this page