export const frontMatter = {
'external help file': 'Keldor-help.xml',
'Module Name': 'Keldor',
'online version': 'https://docs.keldor.dev/powershell/keldor/Test-NetworkSpeed',
schema: '2.0.0'
};
export const contentTitle = 'Test-NetworkSpeed';
export {default as metadata} from '@site/.docusaurus/docusaurus-plugin-content-docs/powershell/site-docs-powershell-keldor-test-network-speed-md-c9e.json'
export const assets = {
};
import {Fragment as _Fragment, jsx as _jsx, jsxs as _jsxs} from "react/jsx-runtime";
import {useMDXComponents as _provideComponents} from "@mdx-js/react";
export const toc = [{
"value": "SYNOPSIS",
"id": "synopsis",
"level": 2
}, {
"value": "SYNTAX",
"id": "syntax",
"level": 2
}, {
"value": "DESCRIPTION",
"id": "description",
"level": 2
}, {
"value": "EXAMPLES",
"id": "examples",
"level": 2
}, {
"value": "EXAMPLE 1",
"id": "example-1",
"level": 3
}, {
"value": "EXAMPLE 2",
"id": "example-2",
"level": 3
}, {
"value": "EXAMPLE 3",
"id": "example-3",
"level": 3
}, {
"value": "EXAMPLE 4",
"id": "example-4",
"level": 3
}, {
"value": "EXAMPLE 5",
"id": "example-5",
"level": 3
}, {
"value": "EXAMPLE 6",
"id": "example-6",
"level": 3
}, {
"value": "PARAMETERS",
"id": "parameters",
"level": 2
}, {
"value": "-FileSize",
"id": "-filesize",
"level": 3
}, {
"value": "-LocalPath",
"id": "-localpath",
"level": 3
}, {
"value": "-RemotePath",
"id": "-remotepath",
"level": 3
}, {
"value": "CommonParameters",
"id": "commonparameters",
"level": 3
}, {
"value": "INPUTS",
"id": "inputs",
"level": 2
}, {
"value": "System.String, System.Int64",
"id": "systemstring-systemint64",
"level": 3
}, {
"value": "OUTPUTS",
"id": "outputs",
"level": 2
}, {
"value": "System.Management.Automation.PSCustomObject",
"id": "systemmanagementautomationpscustomobject",
"level": 3
}, {
"value": "NOTES",
"id": "notes",
"level": 2
}, {
"value": "RELATED LINKS",
"id": "related-links",
"level": 2
}];
function _createMdxContent(props) {
const _components = {
a: "a",
code: "code",
h1: "h1",
h2: "h2",
h3: "h3",
header: "header",
p: "p",
pre: "pre",
..._provideComponents(),
...props.components
};
return _jsxs(_Fragment, {
children: [_jsx(_components.header, {
children: _jsx(_components.h1, {
id: "test-networkspeed",
children: "Test-NetworkSpeed"
})
}), "\n", _jsx(_components.h2, {
id: "synopsis",
children: "SYNOPSIS"
}), "\n", _jsx(_components.p, {
children: "Test network file transfer speeds, upload and download."
}), "\n", _jsx(_components.h2, {
id: "syntax",
children: "SYNTAX"
}), "\n", _jsx(_components.pre, {
children: _jsx(_components.code, {
className: "language-powershell",
children: "Test-NetworkSpeed [[-LocalPath] ] [[-RemotePath] ] [[-FileSize] ] []\n"
})
}), "\n", _jsx(_components.h2, {
id: "description",
children: "DESCRIPTION"
}), "\n", _jsx(_components.p, {
children: "Will test the file transfer speed of a generated file and provide you with the speed in Mbps (Megabit) and MBps (Megabyte) for uploads and downloads to a SMB file share."
}), "\n", _jsx(_components.h2, {
id: "examples",
children: "EXAMPLES"
}), "\n", _jsx(_components.h3, {
id: "example-1",
children: "EXAMPLE 1"
}), "\n", _jsx(_components.pre, {
children: _jsx(_components.code, {
className: "language-powershell",
children: "Test-NetworkSpeed\n"
})
}), "\n", _jsx(_components.p, {
children: "Example of how to use this cmdlet using the configured values in the Keldor config.ps1 file."
}), "\n", _jsx(_components.h3, {
id: "example-2",
children: "EXAMPLE 2"
}), "\n", _jsx(_components.pre, {
children: _jsx(_components.code, {
className: "language-powershell",
children: "Test-NetworkSpeed -FileSize 500KB\n"
})
}), "\n", _jsx(_components.p, {
children: "Another example of how to use this cmdlet but with the FileSize parameter.\nThis example will generate 500 Kilobyte files to transfer."
}), "\n", _jsx(_components.h3, {
id: "example-3",
children: "EXAMPLE 3"
}), "\n", _jsx(_components.pre, {
children: _jsx(_components.code, {
className: "language-powershell",
children: "Test-NetworkSpeed -FileSize 100MB\n"
})
}), "\n", _jsx(_components.p, {
children: "Another example of how to use this cmdlet but with the FileSize parameter.\nThis example will generate 100 Megabyte files to transfer."
}), "\n", _jsx(_components.h3, {
id: "example-4",
children: "EXAMPLE 4"
}), "\n", _jsx(_components.pre, {
children: _jsx(_components.code, {
className: "language-powershell",
children: "Test-NetworkSpeed -FileSize 1GB\n"
})
}), "\n", _jsx(_components.p, {
children: "Another example of how to use this cmdlet but with the FileSize parameter.\nThis example will generate 1 Gigabyte files to transfer."
}), "\n", _jsx(_components.h3, {
id: "example-5",
children: "EXAMPLE 5"
}), "\n", _jsx(_components.pre, {
children: _jsx(_components.code, {
className: "language-powershell",
children: "Test-NetworkSpeed -LocalPath C:\Transfer\n"
})
}), "\n", _jsx(_components.p, {
children: "Another example of how to use this cmdlet but with the local path parameter."
}), "\n", _jsx(_components.h3, {
id: "example-6",
children: "EXAMPLE 6"
}), "\n", _jsx(_components.pre, {
children: _jsx(_components.code, {
className: "language-powershell",
children: "Test-NetworkSpeed -LocalPath D:\Temp -RemotePath \\server1.keldor.dev\Transfer\n"
})
}), "\n", _jsx(_components.p, {
children: "Another example of how to use this cmdlet but with the local and remote path parameters."
}), "\n", _jsx(_components.h2, {
id: "parameters",
children: "PARAMETERS"
}), "\n", _jsx(_components.h3, {
id: "-filesize",
children: "-FileSize"
}), "\n", _jsx(_components.p, {
children: "Specifies the file size of the file to be generated and transferred.\nEnter in the format xxKB, xxMB, or xxGB."
}), "\n", _jsx(_components.pre, {
children: _jsx(_components.code, {
className: "language-yaml",
children: "Type: Int64\nParameter Sets: (All)\nAliases:\n\nRequired: False\nPosition: 3\nDefault value: 0\nAccept pipeline input: False\nAccept wildcard characters: False\n"
})
}), "\n", _jsx(_components.h3, {
id: "-localpath",
children: "-LocalPath"
}), "\n", _jsx(_components.p, {
children: "Specifies the path to the local folder where a file will be generated and where a file will be copied to."
}), "\n", _jsx(_components.pre, {
children: _jsx(_components.code, {
className: "language-yaml",
children: "Type: String\nParameter Sets: (All)\nAliases:\n\nRequired: False\nPosition: 1\nDefault value: None\nAccept pipeline input: False\nAccept wildcard characters: False\n"
})
}), "\n", _jsx(_components.h3, {
id: "-remotepath",
children: "-RemotePath"
}), "\n", _jsx(_components.p, {
children: "Specifies the path to the remote folder where a file will be generated and where a file will be copied to."
}), "\n", _jsx(_components.pre, {
children: _jsx(_components.code, {
className: "language-yaml",
children: "Type: String\nParameter Sets: (All)\nAliases:\n\nRequired: False\nPosition: 2\nDefault value: None\nAccept pipeline input: False\nAccept wildcard characters: False\n"
})
}), "\n", _jsx(_components.h3, {
id: "commonparameters",
children: "CommonParameters"
}), "\n", _jsxs(_components.p, {
children: ["This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see ", _jsx(_components.a, {
href: "http://go.microsoft.com/fwlink/?LinkID=113216",
children: "about_CommonParameters"
}), "."]
}), "\n", _jsx(_components.h2, {
id: "inputs",
children: "INPUTS"
}), "\n", _jsx(_components.h3, {
id: "systemstring-systemint64",
children: "System.String, System.Int64"
}), "\n", _jsx(_components.h2, {
id: "outputs",
children: "OUTPUTS"
}), "\n", _jsx(_components.h3, {
id: "systemmanagementautomationpscustomobject",
children: "System.Management.Automation.PSCustomObject"
}), "\n", _jsx(_components.h2, {
id: "notes",
children: "NOTES"
}), "\n", _jsx(_components.p, {
children: "Author: Skyler Hart\nCreated: 2022-06-24 18:21:40\nLast Edit: 2022-06-24 18:21:40"
}), "\n", _jsx(_components.h2, {
id: "related-links",
children: "RELATED LINKS"
}), "\n", _jsx(_components.p, {
children: _jsx(_components.a, {
href: "https://docs.keldor.dev",
children: "https://docs.keldor.dev"
})
})]
});
}
export default function MDXContent(props = {}) {
const {wrapper: MDXLayout} = {
..._provideComponents(),
...props.components
};
return MDXLayout ? _jsx(MDXLayout, {
...props,
children: _jsx(_createMdxContent, {
...props
})
}) : _createMdxContent(props);
}