Skip to main content

Creating files with powershell

powershell



There comes a time when you need to create files with powershell. Search the web and you will find many solutions. Here I am going to list a few of you options.








First one up is from the Powershell Magazine by Shay Levy:
image

It is a basic functions with some parameters for you to change the path where the file should be written and the size of the file.

Second is from another blog Nate Jones. It is a couple of lines with code for you to run:

image

Third is from Jeffery Hicks. He also use the [IO.File] .Net class to create an advanced function that also supports pipeline input. His function requires Powershell version 4:

image

Click the pictures to find the article about each solution. If you search for your self, you will see pretty much all kinds of variations around the .Net class System.IO.File. Natively in Powershell to my knowledge there is no single cmdlet that lets you create files of an predefined size. So lets dig around and see what we can find.

First we need to discuss the size. Size can be specified in bytes, kilobytes(kb), megabytes(mb), gigabytes(gb) and so on. Lucky for us powershell know about this. So if I need to know how many bytes there is in 1 megabyte, I can just ask powershell by typing the command 1mb:

image

This also works with calculus, so if I type this:

image 

Powershell will print the letter "a" 1024 times because there is 1024 bytes in 1kb. Now we can create “content” of a specific size. All we need now is to find some way of writing this to a file.

Two cmdlets come to mind: Out-File and Set-Content. There is also Add-Content, however that is for appending contents to a file.

First candidate Out-File:

image

We can se that we can create files with this function. We just need to specify a path (FilePath) and an InputObject (the value/content we want the file to have). Lets try to create a file of 10kb:

image

There, the file was created and the size was 20486 bytes. Strange that is more than 10kb, actually it is twice the size we were looking for. Notice in the help information we have a parameter called Encoding. Maybe we need to set the encoding to something, oh we can use UTF8 perhaps:

 image

That is better, pretty close to 10kb. I mentioned Set-Content cmdlet, we should give that one a go as well:

image

Well there you go, even easier to remember, no need to worry about encoding. Set-Content got it right the first time. I prefer to write it like this:

image

First I pick a size and pipe that to the Set-content cmdlet and chose the path and filename.

If speed is a requirement, you are probably best off doing file creation with the .Net class System.IO.File. Any of the functions I mentioned earlier will do that just fine. On my system, creating a 10mb file took 79ms using Set-Content cmdlet. If I use Jeffery’s function it takes about 20ms to create a file. Not a huge difference unless you want to create really huge files or may of them.

Cheers

Tore

Comments

Popular posts from this blog

Developing PowerShell modules for REST APIs – Part1

Over the years I have developed different PowerShell modules for different web APIs. I thought it would be a good idea to write a 2 series post about how you could go about to do this. This will be a 2 part blog series where we will run through the entire process of building a module for a REST API. I will try my best to keep this as simple as possible and leave more advanced stuff for a follow up post if the interest is there.What you needDepending on your experience with source control and PowerShell in general, you might want to use GIT or some other software repro for the code. In addition we are going to create a test REST API using the splendid UniversalDashboard PowerShell module created by Adam Driscoll. It is available on the PowershellGallery. Other prerequisites are built-in to Powershell. I will assume that you will be following along using at least PowerShell version 5 or greater.
What is HTTP metods for REST API.The primary or most common HTTP verbs used are POST, GET, PU…

Serialize data with PowerShell

Currently I am working on a big new module. In this module, I need to persist data to disk and reprocess them at some point even if the module/PowerShell session was closed. I needed to serialize objects and save them to disk. It needed to be very efficient to be able to support a high volume of objects. Hence I decided to turn this serializer into a module called HashData.



Other Serializing methods

In PowerShell we have several possibilities to serialize objects. There are two cmdlets you can use which are built in:
Export-CliXmlConvertTo-JSON
Both are excellent options if you do not care about the size of the file. In my case I needed something lean and mean in terms of the size on disk for the serialized object. Lets do some tests to compare the different types:


(Hashdata.Object.ps1)

You might be curious why I do not use the Export-CliXML cmdlet and just use the [System.Management.Automation.PSSerializer]::Serialize static method. The static method will generate the same xml, however we …

Developing PowerShell modules for REST APIs – Part2

This is part 2 of the REST API blogpost. In part1 we successfully setup two REST API endpoints using the UniversalDashboard PowerShell module. In this part we are going to create a simple module that support some CRUD operation against our API. As we are trying to keep things as simple as possible, we will not use any fancy framework (like Plaster) to build our module. We are also going to skip a very important step you should familiarize yourself with, Pester tests. Lets get to it.


The moduleWe will build a module called FilesAPI. The module folder will look like this:



In the functions folder I have already added the 2 helper functions from part 1, Get-AuthorizationHeader and ConvertTo-Base64. The other folders are just placeholders for important stuff like classes, private functions that you do not want to make available for the module consumer and tests for Pester tests. For such a small module that we are going to create, one could argue that it is much easier to just add the functi…